# resume-cli-dev
> The JSON Resume command line interface
Latest version **0.0.5** (published 2023-05-06) · MIT license · 0 weekly downloads
## Install
```sh
npm install resume-cli-dev
pnpm add resume-cli-dev
yarn add resume-cli-dev
bun add resume-cli-dev
```
Provides the command `resume`.
## Health
**Score 40/100 (D)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 0.0.5 |
| Published | 2023-05-06 |
| First published | 2023-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 17 |
| Unpacked size | 25.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4716 |
| Maintainers | xguimard |
| Keywords | Resume, CV |
## Links
- npm: https://www.npmjs.com/package/resume-cli-dev
- Repository: https://github.com/jsonresume/resume-cli
- Homepage: https://github.com/jsonresume/resume-cli#readme
- Issues: https://github.com/jsonresume/resume-cli/issues
- npm.io page: https://npm.io/package/resume-cli-dev
## Dependencies (17)
- [read](https://npm.io/package/read.md) ^2.1.0
- [chalk](https://npm.io/package/chalk.md) ^5.2.0
- [quaff](https://npm.io/package/quaff.md) ^5.0.0
- [yesno](https://npm.io/package/yesno.md) ^0.4.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [readline](https://npm.io/package/readline.md) ^1.3.0
- [z-schema](https://npm.io/package/z-schema.md) ^6.0.1
- [commander](https://npm.io/package/commander.md) ^10.0.1
- [puppeteer](https://npm.io/package/puppeteer.md) ^20.1.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.35
- [superagent](https://npm.io/package/superagent.md) ^8.0.9
- [browser-sync](https://npm.io/package/browser-sync.md) ^2.29.1
- [resume-schema](https://npm.io/package/resume-schema.md) ^1.0.0
- [z-schema-errors](https://npm.io/package/z-schema-errors.md) ^0.2.1
- [stream-to-string](https://npm.io/package/stream-to-string.md) ^1.2.1
- [jsonresume-theme-even](https://npm.io/package/jsonresume-theme-even.md) ^0.18.1
- [object-path-immutable](https://npm.io/package/object-path-immutable.md) ^4.1.2
## Recent versions
- 0.0.5 (latest) — 2023-05-06
- 0.0.4 — 2023-05-06
- 0.0.2 — 2023-05-05
- 0.0.1 — 2023-05-05
- 0.0.0-development — 2023-05-05
## README
# resume-cli
[](https://gitter.im/jsonresume/public?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/jsonresume/resume-cli/actions)
[](https://david-dm.org/jsonresume/resume-cli)
[](https://david-dm.org/jsonresume/resume-cli#info=devDependencies)
[](https://www.npmjs.org/package/resume-cli)
This is the command line tool for [JSON Resume](https://jsonresume.org), the open source initiative to create a JSON-based standard for resumes.
[Read more...](https://jsonresume.org/schema/)
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;
- [Resumed](https://github.com/rbardini/resumed)
# Getting Started
Install the command-line tool:
```
npm install -g resume-cli
```
## Commands at a glance
| 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/` |
# Usage
## `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 http://jsonresume.org).
## `resume validate`
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 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 ` Example: `--format pdf`
- `--theme ` Example: `--theme even`
## `resume serve`
Starts a web server that serves your local `resume.json`. It will live reload when you make edits to your `resume.json`.
Options:
- `--port `
- `--theme `
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)
# supported resume input types
- [`json`](https://www.json.org/json-en.html): via `JSON.parse`.
- [`yaml`](https://yaml.org/): via [`js-yaml`](https://www.npmjs.com/package/js-yaml)
- `quaff`: if `--resume` is a directory, then the path is passed to [`quaff`](https://www.npmjs.com/package/quaff) and the resulting json is used as the resume. quaff supports a variety of formats in the directory, including javascript modules.
# resume data
- Setting `--resume -` tells the cli to read resume data from standard input (`stdin`), and defaults `--type` to `application/json`.
- Setting `--resume ` reads resume data from `path`.
- Leaving `--resume` unset defaults to reading from `resume.json` on the current working directory.
# resume mime types
Supported resume data mime types are:
- `application/json`
- `text/yaml`
# Development
to test the cli, run the dev script:
```sh
npm run dev -- [cli arguments can be passed after the double-dash]
```
# License
Available under [the MIT license](http://mths.be/mit).
---
_Source: https://npm.io/package/resume-cli-dev · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._