Command line

resume, in your terminal

Create, validate, preview and export your resume. resume-cli is maintained alongside the schema.

npm install -g resume-cli

Node.js 18 or newer, on macOS, Linux or Windows.

Reference

Commands at a glance

Commands
resume init	Create a starter resume.json in the current folder.
resume validate	Check your resume against the schema.
resume export	Export to HTML, PDF, Markdown or plain text.
resume serve	Preview your resume locally, reloading as you edit.
resume themes	List installed themes and the name to pass to --theme.
resume audit	Score how well your resume reads in applicant tracking systems.

resume init

Create a starter resume.json in the current folder.

Examples

resume init

resume validate

Check your resume against the schema.

Exits non-zero on errors, so it works in CI. Point --schema at another schema to validate against it instead.

Examples

resume validate
resume validate --resume cv.json

Options for validate
Option	What it does
`--schema <path>`	Validate against a custom schema.

resume export [fileName]

Export to HTML, PDF, Markdown or plain text.

The format comes from the file extension or --format. HTML and PDF are rendered by a theme; Markdown and text need none. PDF uses headless Chrome: on Linux CI or in containers set RESUME_PUPPETEER_NO_SANDBOX=1.

Examples

resume export resume.md
resume export resume.html --theme even
resume export resume.pdf --theme even
resume export resume.txt --format text

Options for export
Option	What it does
`--format <type>`	html, pdf, markdown (md) or text (txt).
`--theme <name>`	Theme for HTML and PDF. Defaults to even.
`--force`	Skip schema validation.

resume serve

Preview your resume locally, reloading as you edit.

Serves at http://localhost:4000. Theme authors run resume serve --theme . inside their theme folder.

Examples

resume serve --theme elegant
resume serve --port 8080 --silent

Options for serve
Option	What it does
`--theme <name>`	Theme to render with, or a path such as `.`.
`--port <port>`	Defaults to 4000.
`--silent`	Do not open a browser.
`--dir <path>`	Public folder to serve alongside. Defaults to public.

resume themes

List installed themes and the name to pass to --theme.

Looks in your project and global node_modules, without the network. Browse every theme in the gallery.

Examples

resume themes

resume audit [resumeFile]

Score how well your resume reads in applicant tracking systems.

Renders your resume with a theme, runs the ATS checks and prints a score, a grade, each check and recommendations. Advisory: it exits 0 whatever the score.

Examples

resume audit
resume audit resume.json --theme elegant

Options for audit
Option	What it does
`--theme <name>`	Audit the markup a theme produces. Defaults to even.

Global options

Options every command reads
Option	What it does
`-r, --resume <file>`	The resume to read, or - for stdin. Defaults to resume.json.
`-t, --theme <name>`	A theme name (prefixed jsonresume-theme- for you), a scoped package or a path.

Using themes

Install a theme from npm before exporting with it: npm install jsonresume-theme-elegant.
Short names get the jsonresume-theme- prefix: --theme elegant. Scoped packages are passed in full: --theme @jsonresume/jsonresume-theme-professional.
Use a theme you are building with a path: --theme . or --theme ../my-theme.

GalleryBrowse the themesPreview every theme with a real resume.AlternativeresumedA lightweight community CLI that renders with the same themes.

Make a theme of your own

Theme development The schema