This is the command line tool for JSON Resume, the open source initiative to create a JSON-based standard for resumes.
Install the command-line tool:
npm install -g resume-cli
|init||Initialize a |
|validate||Schema validation test your |
|export [fileName.html]||Export locally to |
|serve||Serve resume at |
Show a list of options and commands for the CLI.
Creates a new
resume.json file in your current working directory.
resume.json with your text editor. Be sure to follow the schema
(available at http://jsonresume.org).
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 or PDF format.
A list of available themes can be found here: http://jsonresume.org/themes/
Please npm install the theme you wish to use locally before attempting to export it.
--format <file type>Example:
Starts a web server that serves your local
resume.json. It will live reload when you make edits to your
When developing themes, simply change into your theme directory and run
resume serve --theme . (which tells it to run the local folder as the specified theme)
--resumeis a directory, then the path is passed to
--resume -tells the cli to read resume data from standard input (
stdin), and defaults
--resume <path>reads resume data from
--resumeunset defaults to reading from
resume.jsonon the current working directory.
Supported resume data mime types are:
to test the cli, run the dev script:
npm run dev -- [cli arguments can be passed after the double-dash]
Available under the MIT license.