Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anthonyjdella/customized-resume-cli
🍴 I tweaked this CLI tool to work with my custom JSON schema.
https://github.com/anthonyjdella/customized-resume-cli
Last synced: 1 day ago
JSON representation
🍴 I tweaked this CLI tool to work with my custom JSON schema.
- Host: GitHub
- URL: https://github.com/anthonyjdella/customized-resume-cli
- Owner: anthonyjdella
- License: mit
- Created: 2022-11-07T07:51:56.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-07T23:32:03.000Z (about 2 years ago)
- Last Synced: 2025-01-17T03:20:30.390Z (19 days ago)
- Language: JavaScript
- Homepage: https://jsonresume.org
- Size: 17.5 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Customized JSON Resume CLI
🖼️ This is a tweaked version of the [JSON Resume CLI](https://github.com/jsonresume/resume-cli). Why did I customize it? This version works with my custom JSON schema!
Click to expand README.md of the source repository!
# 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 [`yaml-js`](https://www.npmjs.com/package/yaml-js)
- `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).