YAMLResume CLI

YAMLResume is a command-line tool that lets you manage your resume as code. Write your resume in YAML and compile it into a beautifully typeset, professional PDF.

Important: PDF generation requires a LaTeX installation. For detailed instructions, please see the Installation Guide.

If you don't have LaTeX installed, you can use Docker to run YAMLResume:

YAMLResume is a full fledged resume compiler, which provides a builtin schema to validate resumes and help avoid lots of low level mistakes.

Quick Start

First, install the CLI using your favorite package manager:

# using npm
$ npm install -g yamlresume

# using yarn
$ yarn global add yamlresume

# using pnpm
$ pnpm add -g yamlresume

# using bun
$ bun add -g yamlresume
Copy

Then, verify the installation:

yamlresume help
Copy

Usage

1. Create a New Resume

Use the new command to bootstrap a resume from a template. For more details, see the new command docs.

yamlresume new my-resume.yml
Copy

2. Build the Resume

Compile your YAML file into a PDF. For all available options, see the build command docs.

yamlresume build my-resume.yml
Copy

This generates my-resume.tex and my-resume.pdf in the same directory.

Documentation

For more detailed information, please visit our official documentation:

• Quick Start: A comprehensive guide to get you started.
• CLI Reference: Full reference for all commands.
• Schema Validation: The complete resume schema reference.
• Multi Language Support: Learn how to write resumes in multiple languages.
• Templates: Learn how to use and create templates.

Support the Project

If you find YAMLResume helpful, consider supporting the project: