Skip to content

phoinixi/resuml

Repository files navigation

✨ resuml

Resume as code. YAML in, beautiful resume out.

npm version npm downloads license GitHub stars

👉 Try it in your browser at resuml.app


Three ways to use it

🌐 The web app at resuml.app

Free, open source, no signup. Your resume data stays in your browser. We don't store or track anything. Write in YAML or use the form editor, pick from 300+ themes, check your ATS match against a job description, and export to PDF.

🤖 With Claude Code / AI agents (MCP)

resuml ships with a built-in MCP server so Claude Code can read your resume, tailor it to a job description, check the ATS score, and render it, all from a chat.

One-command setup (recommended):

claude mcp add resuml -- npx resuml mcp

That registers resuml for the current project. Add --scope user to make it available across all projects:

claude mcp add --scope user resuml -- npx resuml mcp

Verify it's wired up:

claude mcp list

Or, for teams sharing the config via git, create .mcp.json at the repo root:

{
  "mcpServers": {
    "resuml": {
      "command": "npx",
      "args": ["resuml", "mcp"]
    }
  }
}

Then ask Claude Code things like:

"Tailor my resume at resume.yaml to this job description, hit ATS score ≥ 80, and render it with the stackoverflow theme."

Claude will generate the YAML, validate it, iterate until the score clears, and render the final HTML. See DOCS.md for all tools, resources, and prompts.

💻 The CLI

npm install -g resuml

# install a theme on demand (any jsonresume-theme-* package)
npm install -g jsonresume-theme-stackoverflow

resuml validate --resume resume.yaml --ats --jd job.txt
resuml render   --resume resume.yaml --theme stackoverflow --output resume.html
resuml pdf      --resume resume.yaml --theme stackoverflow --output resume.pdf

resuml pdf and snapshot rendering need Playwright. Install it once with npm install -g playwright (it's an optional peer dep so the base install stays slim).

Minimal resume.yaml:

basics:
  name: Jane Smith
  label: Senior Software Engineer
  email: jane@example.com
  summary: >-
    Engineer with 8+ years building scalable distributed systems.
work:
  - name: Acme Corp
    position: Lead Engineer
    startDate: 2020-01-15
    highlights:
      - Reduced deploy time by 60%
      - Led team of 12 engineers

Full CLI reference, ATS rubric, CI/CD setup, and every MCP tool live in DOCS.md.


Requirements

  • Node.js ≥ 20, npm ≥ 10
  • Optional: playwright for resuml pdf

Contributing

PRs welcome. See DOCS.md for architecture and dev setup.

License

ISC. Support the project: ☕ Buy me a coffee.

About

Resume as code with YAML. Your data stays in your browser. https://resuml.app/about

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors