Cli tool to easily setup a new resume πŸ“‘
Clone or download
Latest commit 5aaf9b8 Jun 9, 2018


Gitter Build Status Dependency Status devDependency Status

This is the command line tool for JSON Resume, the open source initiative to create a JSON-based standard for resumes.



Bountysource Support via Gratipay tip for next commit


Use your favorite IRC client to join the #jsonresume channel on Freenode.

Or instead, you can use the web client:

Getting Started

Install the command-line tool:

npm install -g resume-cli


resume --help

Show a list of options and commands for the CLI.

resume init

Creates a new resume.json file in your current working directory.

Complete the resume.json with your text editor. Be sure to follow the schema (available at

resume test

Validates your resume.json against our schema tests to ensure it complies with the standard. Tries to identify where any errors may be occurring.

resume export [fileName]

Exports your resume locally in a stylized HTML, Markdown, or PDF format.

A list of available themes can be found here:

Please npm install the theme you wish to use locally before attempting to export it.


  • --format <file type> Example: --format pdf
  • --theme <name> Example: --theme flat

resume register

Registration is optional.

To publish your resume to your account with a custom domain extension at You will first need to acquire login credentials.

resume login

To log into a registered account. This will allow you to publish with requiring you to reenter your credentials.

resume publish

This command will guide you through the publish process.


  • --theme <name> Style your resume. (Default: flat)

resume serve

Starts a web server that serves your local resume.json.


  • --port <port>
  • --theme <name>

If no theme is specified, it will look for the file index.js and call render(). This is useful when developing themes.


Available under the MIT license.