CLI

YAMLResume provides a CLI tool to help you manage your resume. You can follow the installation guide to install it.

YAMLResume CLI in docker

Please note that we have a docker image for you, which has yamlresume CLI installed with all the necessary dependencies.

For each sub-command in this guide, you can run it in docker by appending the sub-command after yamlresume/yamlresume.

For example, to create a new resume in yamlresume CLI:

yamlresume new my-resume.yml

You can also run it in docker by:

docker run --rm -v $(pwd):/home/yamlresume yamlresume/yamlresume new my-resume.yml

Help

Show CLI help and all available commands:

$ yamlresume help
Usage: yamlresume [options] [command]

YAMLResume — Resume as Code in YAML

 __   __ _    __  __ _     ____
 \ \ / // \  |  \/  | |   |  _ \ ___  ___ _   _ ___  ___   ___
  \ V // _ \ | |\/| | |   | |_) / _ \/ __| | | / _ \/ _ \ / _ \
   | |/ ___ \| |  | | |___|  _ <  __/\__ \ |_| | | | | | |  __/
   |_/_/   \_\_|  |_|_____|_| \_\___||___/\____|_| |_| |_|\___|


Options:
  -V, --version             output the version number
  -v, --verbose             verbose output
  -h, --help                display help for command

Commands:
  new [filename]            create a new resume
  build [options] <source>  build a resume to LaTeX and PDF
  languages                 i18n and l10n support
  templates                 manage resume templates
  help [command]            display help for command

Show YAMLResume CLI version:

$ yamlresume -V
0.4.0

New

Create a new resume. The default resume filename is resume.yml, but you can specify a custom filename:

$ yamlresume new --help
Usage: yamlresume new [options] [filename]

create a new resume

Arguments:
  filename    output filename (default: "resume.yml")

Options:
  -h, --help  display help for command

$ yamlresume new my-resume.yml
✔ Created my-resume.yml successfully.

Build

Build a resume from YAML to PDF. It will generate the latex code and PDF at the same time, with some intermediate files .aux, .log etc, if you use XeTeX as the typesetting engine.

$ yamlresume build --help
Usage: yamlresume build [options] <source>

build a resume to LaTeX and PDF

Arguments:
  source      the source resume file

Options:
  --no-pdf    only generate TeX file without PDF
  -h, --help  display help for command

$ yamlresume build my-resume.yml
◐ Generating resume PDF file with command: xelatex -halt-on-error my-resume.tex...
✔ Generated resume PDF file successfully.

List all available languages. The language code follows the spec in ISO 639 specification. You can specify the language code in layout.locale.language in order to change the language of your resume. Changing the language of your resume will automatically translate all fixed terms. You can check more details in our content -> multi languages section.

$ yamlresume languages list

| `layout.locale.language` | Language Name                   |
| ------------------------ | ------------------------------- |
| en                       | English                         |
| zh-hans                  | Simplified Chinese              |
| zh-hant-hk               | Traditional Chinese (Hong Kong) |
| zh-hant-tw               | Traditional Chinese (Taiwan)    |
| es                       | Spanish                         |

Templates

List all available templates. You can change the resume template by setting layout.template in your YAML resume. PPResume Templates for more details.

$ yamlresume templates list

| `layout.template` | Template Name    | Description                          |
| ----------------- | ---------------- | ------------------------------------ |
| moderncv-banking  | ModernCV Banking | ModernCV template with banking style |
| moderncv-casual   | ModernCV Casual  | ModernCV template with casual style  |
| moderncv-classic  | ModernCV Classic | ModernCV template with classic style |

Help

New

Build

Languages

Templates

On this page