Home

Awesome

resume-cli

matrix Build status npm package

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

Project Status

This repository is not actively maintained. It's recommended to use one of the third-party clients that support the JSON Resume standard instead:

Getting Started

Install the command-line tool:

npm install -g resume-cli

Usage

Commands at a Glance

CommandDescription
initInitialize a resume.json file.
validateSchema validation test your resume.json.
export path/to/file.htmlExport to .html.
serveServe resume at http://localhost:4000/.

resume --help

Show a list of options and commands for the <abbr title="Command-line Interface">CLI</abbr>.

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 https://jsonresume.org/schema/).

resume validate

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

resume export [fileName]

Exports your resume in a stylized HTML or PDF format.

A list of available themes can be found here:
https://jsonresume.org/themes/

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

Options:

resume serve

Starts a web server that serves your local resume.json. It will live reload when you make changes to your resume.json.

Options:

When developing themes, change into your theme directory and run resume serve --theme ., which tells it to run the local folder as the specified theme.

This is not intended for production use, it's a convenience for theme development or to visualize changes to your resume while editing it.

Supported Resume Input Types

Resume Data

Resume MIME Types

Supported resume data MIME types are:

License

Available under the MIT license.