JSON Resume Docs
Guides

CLI

Render and validate resume.json locally with resume-cli.

npm install -g resume-cli
# or run without installing
npx resume-cli --help

resume-cli needs Node.js 18 or later. Source: packages/cli.

Commands

CommandWhat it does
resume initCreates resume.json from the sample (prompts for name and email)
resume validateChecks resume.json against the schema
resume export <file>Writes .html, .pdf, .md or .txt, chosen by the extension
resume serveServes your resume at http://localhost:4000 with live reload
resume themesLists the themes installed locally (the names to pass to --theme)
resume auditScores the resume for applicant-tracking-system friendliness

Common options:

  • --resume <file>: use a file other than resume.json (- reads stdin). A .jsonc file may contain comments and trailing commas
  • --theme <name>: theme for HTML and PDF; defaults to even
  • --format <type>: set the export format explicitly

Themes

--theme even resolves the npm package jsonresume-theme-even. Install themes in your project (npm install jsonresume-theme-<name>); the CLI also finds the themes it ships with. Scoped packages are passed by their full name:

resume export resume.html --theme @jsonresume/jsonresume-theme-professional

A local theme under development can be passed as a path:

resume export resume.html --theme ./my-theme

PDF on Linux CI and containers

PDF export runs headless Chrome. Where Chrome can't start its sandbox (common in Docker and CI), set:

RESUME_PUPPETEER_NO_SANDBOX=1 resume export resume.pdf

Alternative: resumed

resumed is a smaller community CLI with the same theme ecosystem:

npm install -g resumed jsonresume-theme-even
resumed render resume.json --theme jsonresume-theme-even

On this page