/resumed

👔 Lightweight JSON Resume builder, no-frills alternative to resume-cli

Primary LanguageTypeScriptMIT LicenseMIT

Resumed

npm package version Build status Code coverage Dependencies status

👔 Lightweight JSON Resume builder, no-frills alternative to resume-cli.

  • 🗜️ Small (~120 LOC)
  • 📦 Pure ESM package
  • 🧩 CLI and Node.js API
  • 🤖 TypeScript typings
  • ⏱️ Async render support
  • 🧪 100% code coverage

Installation

npm install resumed jsonresume-theme-even # or your theme of choice

Usage

$ resumed --help

  Usage
    $ resumed <command> [options]

  Available Commands
    render      Render resume
    init        Create sample resume
    validate    Validate resume

  For more info, run any command with the `--help` flag
    $ resumed render --help
    $ resumed init --help

  Options
    -v, --version    Displays current version
    -h, --help       Displays this message

See examples.

Commands

render (default)

Render resume.

Usage: resumed render [filename] [options]

Aliases: export

Options:

  • -o, --output: Output filename (default resume.html)
  • -t, --theme: Theme to use
  • -h, --help: Display help message

init

Create sample resume.

Usage: resumed init [filename] [options]

Aliases: create

Options:

  • -h, --help: Display help message

validate

Validate resume.

Usage: resumed validate [filename] [options]

Options:

  • -h, --help: Display help message

Motivation

resume-cli is the original command line tool for JSON Resume, the open source initiative to create a JSON-based standard for resumes. It has served the community well for years, but its broad scope and aging codebase has become increasingly harder to maintain.

Resumed is a complete reimplementation of resume-cli, using more modern technologies while dropping certain features, to remain small and focused.

Theme resolution

Resumed does not install any themes. You must pick and install one yourself, and specify your choice via the --theme option or the .meta.theme field of your resume.

In contrast, resume-cli comes with a default theme, and only supports the --theme option. This is fine for most users, but it ties the default theme package release cycle to that of the CLI, and may be a little more verbose.

Interface

While both tools can be used from the command line, Resumed also provides a fully-tested, strongly-typed Node.js API to create, validate and render resumes programatically.

Other features

Resumed makes some compromises in terms of features, such as no PDF export, local previews or YAML format support. If you miss any of these, you can combine Resumed with other tools, (e.g. Puppeteer for PDF generation, see example) or continue using resume-cli.