๐ผ๏ธ This is a tweaked version of the JSON Resume CLI. Why did I customize it? This version works with my custom JSON schema!
Click to expand README.md of the source repository!
This is the command line tool for JSON Resume, the open source initiative to create a JSON-based standard for resumes.
Alternatives: The Resume CLI tool works as it is so there isn't a huge amount of active development on it, try these alternatives if it doesn't work for you;
Install the command-line tool:
npm install -g resume-cli
| command | description |
|---|---|
| init | Initialize a resume.json file |
| validate | Schema validation test your resume.json |
| export [fileName.html] | Export locally to .html |
| serve | Serve resume at http://localhost:4000/ |
Show a list of options and commands for the CLI.
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 http://jsonresume.org).
Validates your resume.json against our schema tests to ensure it complies with
the standard. Tries to identify where any errors may be occurring.
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.
Options:
--format <file type>Example:--format pdf--theme <name>Example:--theme even
Starts a web server that serves your local resume.json. It will live reload when you make edits to your resume.json.
Options:
--port <port>--theme <name>
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)
json: viaJSON.parse.yaml: viayaml-jsquaff: if--resumeis a directory, then the path is passed toquaffand the resulting json is used as the resume. quaff supports a variety of formats in the directory, including javascript modules.
- Setting
--resume -tells the cli to read resume data from standard input (stdin), and defaults--typetoapplication/json. - Setting
--resume <path>reads resume data frompath. - Leaving
--resumeunset defaults to reading fromresume.jsonon the current working directory.
Supported resume data mime types are:
application/jsontext/yaml
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.