resumed

Unlike resume-cli, Resumed does not include a default theme. You must install a theme package manually. Resumed determines which theme to use via one of two methods:

1. The --theme CLI option.
2. The .meta.theme field within your JSON resume file.

Resumed provides a CLI for rendering, exporting, initializing, and validating resumes. Use the following command structure:

resumed <command> [options]

Available commands:

• render: Render resume to HTML.
• export: Export resume to PDF.
• init: Create a sample resume file.
• validate: Validate the resume against the JSON Resume schema.

$ resumed --help

To use Resumed with a custom local theme instead of a remote one, you can clone the local theme example repository. This setup allows you to define and manage your own theme files directly within your project structure.

Follow these steps to set up and run the local theme example:

1. Clone the example using degit.
2. Install the necessary dependencies.
3. Initialize the project (e.g., creating a default resume file).
4. Start the development server to render the resume.

npx degit rbardini/resumed/examples/with-local-theme
npm install
npm run init
npm start

To see how to integrate Resumed with the Even JSON Resume theme, you can clone this specific example repository. This setup demonstrates the full workflow of initializing a resume, installing dependencies, and rendering the output using the theme.

npx degit rbardini/resumed/examples/with-jsonresume-theme
npm install
npm run init
npm start

To use Resumed, you must install the resumed package along with a JSON Resume theme of your choice (e.g., jsonresume-theme-even).

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

You can interact with Resumed programmatically using its Node.js API instead of the CLI. This allows you to integrate resume rendering, validation, and exporting directly into your own Node.js applications or build scripts.

To explore a working implementation, you can clone the official Node.js API example repository.

npx degit rbardini/resumed/examples/with-node-api
npm install
npm run init
npm start

To run the PDF export demonstration, clone the example directory using degit, install the necessary dependencies, initialize the project, and start the process using the following commands:

npx degit rbardini/resumed/examples/with-pdf-export
npm install
npm run init
npm start

The validate command checks your JSON resume file to ensure it adheres to the expected schema.

Usage: resumed validate [filename] [options]

# Example: Validate resume.json
resumed validate resume.json

The render command converts a JSON resume file into an HTML file. By default, it is the primary command used for rendering.

Usage: resumed render [filename] [options]

Options:

• -o, --output: Specify the output filename.
• -t, --theme: Specify the theme to use.

# Example: Render resume.json using the 'even' theme to output resume.html
resumed render resume.json --theme jsonresume-theme-even --output resume.html

The init command (aliased as create) generates a sample JSON resume file to help you get started.

Usage: resumed init [filename] [options]

# Example: Create a sample resume named my-resume.json
resumed init my-resume.json

The export command uses Puppeteer to convert your JSON resume into a PDF file.

Usage: resumed export [filename] [options]

Options:

• -o, --output: Specify the output filename.
• -t, --theme: Specify the theme to use.
• --puppeteer-arg: Pass a launch argument to Puppeteer.

# Example: Export resume.json to resume.pdf
resumed export resume.json --output resume.pdf