{"id":13426751,"url":"https://github.com/jsonresume/resume-cli","last_synced_at":"2025-04-29T18:25:55.065Z","repository":{"id":37396943,"uuid":"20849484","full_name":"jsonresume/resume-cli","owner":"jsonresume","description":"CLI tool to easily setup a new resume 📑","archived":false,"fork":false,"pushed_at":"2024-04-03T15:02:18.000Z","size":18675,"stargazers_count":4615,"open_issues_count":50,"forks_count":393,"subscribers_count":59,"default_branch":"master","last_synced_at":"2025-04-25T17:06:15.848Z","etag":null,"topics":["cli","javascript","json","resume"],"latest_commit_sha":null,"homepage":"https://jsonresume.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsonresume.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-06-15T06:21:01.000Z","updated_at":"2025-04-22T03:49:43.000Z","dependencies_parsed_at":"2024-01-08T07:58:04.069Z","dependency_job_id":"c9330815-8169-4daa-9fc8-a458ee5ec088","html_url":"https://github.com/jsonresume/resume-cli","commit_stats":{"total_commits":502,"total_committers":68,"mean_commits":7.382352941176471,"dds":0.5358565737051793,"last_synced_commit":"0f7f57c16bc5700f2dbb6309d3cbcd2547af2687"},"previous_names":[],"tags_count":106,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsonresume%2Fresume-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsonresume%2Fresume-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsonresume%2Fresume-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsonresume%2Fresume-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsonresume","download_url":"https://codeload.github.com/jsonresume/resume-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251191492,"owners_count":21550140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","javascript","json","resume"],"created_at":"2024-07-31T00:01:43.538Z","updated_at":"2025-04-29T18:25:55.037Z","avatar_url":"https://github.com/jsonresume.png","language":"JavaScript","readme":"# resume-cli\n\n[![matrix](https://img.shields.io/badge/matrix-join%20chat-%230dbd8b)](https://matrix.to/#/#json-resume:one.ems.host)\n[![Build status](https://img.shields.io/github/actions/workflow/status/jsonresume/resume-cli/test.yml?branch=master)](https://github.com/jsonresume/resume-cli/actions)\n[![npm package](https://badge.fury.io/js/resume-cli.svg)](https://www.npmjs.org/package/resume-cli)\n\nThis is the command line tool for [JSON Resume](https://jsonresume.org), the open-source initiative to create a JSON-based standard for resumes.\n\n## Project Status\n\nThis repository is not actively maintained. It's recommended to use one of the third-party clients that support the JSON Resume standard instead:\n\n* [Resumed](https://github.com/rbardini/resumed)\n\n## Getting Started\n\nInstall the command-line tool:\n\n```\nnpm install -g resume-cli\n```\n\n## Usage\n\n### Commands at a Glance\n\n| Command | Description |\n|---|---|\n| init | Initialize a `resume.json` file. |\n| validate | Schema validation test your `resume.json`. |\n| export path/to/file.html | Export to `.html`. |\n| serve | Serve resume at `http://localhost:4000/`. |\n\n### `resume --help`\n\nShow a list of options and commands for the \u003cabbr title=\"Command-line Interface\"\u003eCLI\u003c/abbr\u003e.\n\n### `resume init`\n\nCreates a new `resume.json` file in your current working directory.\n\nComplete the `resume.json` with your text editor. Be sure to follow the schema (available at https://jsonresume.org/schema/).\n\n### `resume validate`\n\nValidates your `resume.json` against our schema to ensure it complies with the standard. Tries to identify where any errors may be occurring.\n\n### `resume export [fileName]`\n\nExports your resume in a stylized HTML or PDF format.\n\nA list of available themes can be found here:  \nhttps://jsonresume.org/themes/\n\nPlease npm install the theme you wish to use before attempting to export it.\n\nOptions:\n\n- `--format \u003cfile type\u003e` Example: `--format pdf`\n- `--theme \u003cname\u003e` Example: `--theme even`\n\n### `resume serve`\n\nStarts a web server that serves your local `resume.json`. It will live reload when you make changes to your `resume.json`.\n\nOptions:\n\n- `--port \u003cport\u003e`\n- `--theme \u003cname\u003e`\n\nWhen developing themes, change into your theme directory and run `resume serve --theme .`, which tells it to run the local folder as the specified theme.\n\nThis is not intended for production use, it's a convenience for theme development or to visualize changes to your resume while editing it.\n\n## Supported Resume Input Types\n\n- [`json`](https://www.json.org/json-en.html): via `JSON.parse`.\n- [`yaml`](https://yaml.org/): via [`yaml-js`](https://www.npmjs.com/package/yaml-js)\n- `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.\n\n## Resume Data\n\n- Setting `--resume -` tells the CLI to read resume data from standard input (`STDIN`), and defaults `--type` to `application/json`.\n- Setting `--resume \u003cpath\u003e` reads resume data from `path`.\n- Leaving `--resume` unset defaults to reading from `resume.json` on the current working directory.\n\n## Resume MIME Types\n\nSupported resume data MIME types are:\n\n- `application/json`\n- `text/yaml`\n\n## License\n\nAvailable under [the MIT license](http://mths.be/mit).\n","funding_links":[],"categories":["JavaScript","cli","Tools","json"],"sub_categories":["Node"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsonresume%2Fresume-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsonresume%2Fresume-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsonresume%2Fresume-cli/lists"}