CLI

YAMLResume は履歴書の管理を支援する CLI ツールを提供します。インストールガイドに従ってインストールできます。

Docker での YAMLResume CLI

docker イメージをご用意しており、yamlresume CLI およびすべての必要な依存関係がインストールされていることに注意してください。

このガイドの各サブコマンドについて、yamlresume/yamlresume の後にサブコマンドを追加することで docker で実行できます。

例えば、yamlresume CLI で新しい履歴書を作成：

yamlresume new my-resume.yml

docker でも実行できます：

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

ヘルプ

CLI ヘルプとすべての利用可能なコマンドを表示：

$ 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:
  ai                             AI-powered resume generation
  build [options] <resume-path>  build a resume to Docx, HTML, Markdown or
                                 LaTeX/PDF
  dev [options] <resume-path>    build a resume on file changes (watch mode)
  doctor                         check environment for YAMLResume dependencies
  languages                      i18n and l10n support
  new [options] [filename]       create a new resume
  samples                        manage sample resumes
  templates                      manage resume templates
  validate <resume-path>         validate a resume against the YAMLResume schema
  help [command]                 display help for command

YAMLResume CLI のバージョンを表示：

$ yamlresume -V
0.15.3

New

新しい履歴書を作成します。デフォルトの履歴書ファイル名は resume.yml ですが、カスタムファイル名を指定できます：

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

create a new resume

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

Options:
  --sample <id>          create from a curated sample resume
  --language <language>  locale language for the sample (default: "en")
  -h, --help             display help for command

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

v0.15.0 以降、yamlresume new は厳選されたサンプル履歴書から履歴書を生成します（デフォルトは英語の software-engineer サンプルです）。生成されるファイルには、エディター/IDE でのスキーマ検証に役立つ YAML コメントとデフォルトのレイアウトが含まれているため、すぐにビルドできます。

`--sample`

特定のサンプル履歴書から始めたい場合は、--sample オプションを使用します。yamlresume samples list を実行すると、利用可能なすべてのサンプルを確認できます：

$ yamlresume new ux-designer.yml --sample ux-designer
✔ Created ux-designer.yml from sample "ux-designer" successfully.

存在しないサンプル ID が指定された場合、CLI は選択の助けとして利用可能なすべてのサンプルを表示します：

$ yamlresume new my-resume.yml --sample no-such-sample

 ERROR  Sample resume not found: no-such-sample

ℹ Available samples:
  - data-analyst: Data Analyst
  - data-scientist: Data Scientist
  - product-manager: Product Manager
  - software-engineer: Software Engineer
  - ux-designer: UX Designer

`--language`

すべてのサンプル履歴書は 12 のロケール言語に翻訳されています。--language オプションを使用すると、ローカライズされたサンプルから履歴書を作成できます。これは英語以外の履歴書を書く際に非常に便利です：

$ yamlresume new my-resume.yml --sample software-engineer --language zh-hans
✔ Created my-resume.yml successfully.

サンプル履歴書

YAMLResume には、一般的な職種向けに厳選されたサンプル履歴書セットが付属しており、12 のロケール言語（de、en、es、fr、id、ja、nl、no、pt-br、zh-hans、zh-hant-hk、zh-hant-tw）に翻訳されています。samples list サブコマンドですべてをリストできます：

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

manage sample resumes

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

Commands:
  list            list all sample resumes
  help [command]  display help for command

$ yamlresume samples list

| ID                | Position          | Title             | Category       |
| ----------------- | ----------------- | ----------------- | -------------- |
| data-analyst      | data analyst      | Data Analyst      | Data Analytics |
| data-scientist    | data scientist    | Data Scientist    | Data Science   |
| product-manager   | product manager   | Product Manager   | Product        |
| software-engineer | software engineer | Software Engineer | Engineering    |
| ux-designer       | ux designer       | UX Designer       | Design         |

yamlresume new --sample <id> を使用して、サンプルから新しい履歴書ファイルを作成できます。

Build

YAML から PDF に履歴書をビルド。latex コードと PDF の両方を生成し、XeTeX をタイプセッティングエンジンとして使用する場合、.aux、.log などのいくつかの中間ファイルも生成されます。

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

build a resume to LaTeX, PDF, Markdown, or HTML

Arguments:
  resume-path              the resume file path

Options:
  --no-pdf                 only generate TeX file without PDF (for LaTeX layouts)
  --no-validate            skip resume schema validation
  -o, --output <dir>       output directory for generated files
  -t, --timeout <seconds>  timeout for LaTeX compilation in seconds (default: 30, 0 to disable)
  -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.

`--no-pdf`

LaTeX ファイルのみを生成し、PDF を生成したくない場合は、--no-pdf オプションを使用できます。

$ yamlresume build --no-pdf my-resume.yml

`--no-validate`

履歴書スキーマ検証をスキップしたい場合は、--no-validate オプションを使用できます。

$ yamlresume build --no-validate my-resume.yml

`--output`

生成されたファイルの出力ディレクトリを指定したい場合は、-o, --output オプションを使用できます。

$ yamlresume build -o ./output my-resume.yml

`--timeout`

LaTeX コンパイルのタイムアウトをカスタマイズしたい場合は、--timeout オプションを使用できます。デフォルトのタイムアウトは 30 秒です。0 に設定するとタイムアウトを無効にできます。

$ yamlresume build --timeout 60 my-resume.yml

Dev

ファイル変更時に YAML から PDF に履歴書をビルド。build と同じオプションを受け入れますが、YAML ファイルが変更されると自動的に履歴書を再ビルドします（つまり、ウォッチモード）。履歴書の変更をリアルタイムでプレビューするのに非常に便利です。

$ yamlresume dev --help
Usage: yamlresume dev [options] <resume-path>

build a resume on file changes (watch mode)

Arguments:
  resume-path    the resume file path

Options:
  --no-pdf       only generate TeX file without PDF
  --no-validate  skip resume schema validation
  -h, --help     display help for command

Validate

YAMLResume スキーマに従って履歴書を検証。

$ yamlresume validate --help
Usage: yamlresume validate [options] <resume-path>

validate a resume against the YAMLResume schema

Arguments:
  resume-path  the resume file path

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

例えば、以下の履歴書について：

# yaml-language-server: $schema=https://yamlresume.dev/schema.json

---
content:
  basics:
    name: Andy Dufresne
    headline: Headed for the Pacific
    phone: "(213) 555-9876"
    email: hi@pp
    url: https://ppresume.com/gallery
    summary: |
      - Computer Science major with strong foundation in data structures, algorithms, and software development
      - Pixel perfect full stack web developer, specialised in creating high-quality, visually appealing websites
      - Experiened in databases (SQL, NoSQL), familiar with server-side technologies (Node.js, Express, etc.)
      - Team player, with detail-oriented mindset and a keen eye for design and user experiences
  location:
    address: 123 Main Street
    region: California
    city: S
    country: United States
    postalCode: "95814"
  education:
    - institution: University of Southern California
      url: https://www.cs.usc.edu/
      degree: Bachelor
      area: Computer Engineering and Computer Science
      score: "3.8"
      startDate: Sep 1, 2016
      endDate:
      courses:
        - D
        - Programming Language Concepts
      summary: |
        - Developed proficiency in programming languages such as Java, C++, and Python
        - Gained hands-on experience in software development through various projects and assignments
        - Strong communication and teamwork skills acquired through group projects and presentations

layouts:
  - engine: latex
    typography:
      fontSize: 13pt

yamlresume validate は潜在的なエラーのリストを提供し、明確な位置情報を提供します

$ yamlresume validate invalid-resume.yml
invalid-resume.yml:9:12: warning: email is invalid.
    email: hi@pp
           ^
invalid-resume.yml:19:11: warning: city should be 2 characters or more.
    city: S
          ^
invalid-resume.yml:31:11: warning: courses should be 2 characters or more.
        - D
          ^
invalid-resume.yml:41:17: warning: font size option is invalid, it must be one of the following: ["10pt", "11pt", "12pt"]
    fontSize: 13pt
              ^
✖ Resume validation failed.

Doctor

YAMLResume の依存関係について環境をチェックします。このコマンドは、必要なすべてのツールとフォントが正しくインストールされているかを確認することで、セットアップの問題を診断するのに役立ちます。

$ yamlresume doctor

  System:
    OS: macOS 14.6.1
    CPU: (10) arm64 Apple M1 Max
  Binaries:
    Node: 25.6.0 - /opt/homebrew/bin/node
    Yarn: 1.22.22 - /Users/hanyu/Library/pnpm/yarn
    npm: 11.8.0 - /opt/homebrew/bin/npm
    pnpm: 10.6.3 - /opt/homebrew/bin/pnpm

ℹ Checking XeTeX...
  XeTeX: XeTeX 3.141592653-2.6-0.999994 (TeX Live 2022)

ℹ Checking Tectonic...
  Tectonic: tectonic 0.15.0

ℹ Checking Fonts...
  Linux Libertine O: Not Installed
  Linux Libertine: Installed
  Noto Serif CJK SC: Installed
  Noto Sans CJK SC: Installed

doctor コマンドは以下をチェックします:

システム情報: OS、CPU アーキテクチャ
バイナリ: Node.js、npm、pnpm、Yarn、Bun
LaTeX エンジン: XeTeX と Tectonic の利用可能性
フォント: 最適な履歴書レンダリングに必要なフォント（ラテン文字用の Linux Libertine、中国語/日本語/韓国語用の Noto CJK）

これは、新しいマシンで YAMLResume をセットアップする際や、履歴書ビルドの問題をトラブルシューティングする際に特に役立ちます。

Languages

すべての利用可能な言語をリスト。言語コードは ISO 639 仕様の仕様に従います。locale.language で言語コードを指定して履歴書の言語を変更できます。履歴書の言語を変更すると、すべての固定用語が自動的に翻訳されます。詳細についてはコンテンツ -> 多言語セクションをご覧ください。

$ yamlresume languages list

| 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                         |
| fr              | French                          |
| no              | Norwegian                       |
| nl              | Dutch                           |
| ja              | Japanese                        |
| de              | German                          |
| id              | Indonesian                      |
| pt-br           | Brazilian Portuguese            |

Templates

すべての利用可能なテンプレートをリスト。YAML 履歴書で layouts.[].template を設定することで履歴書テンプレートを変更できます。詳細については PPResume テンプレートをご覧ください。

$ yamlresume templates list

| layouts.[].template | Engine | Template Name    | Description                                                         |
| ------------------- | ------ | ---------------- | ------------------------------------------------------------------- |
| jake                | latex  | Jake's Resume    | A simple, straight-forward resume template based on Jake's Resume   |
| moderncv-banking    | latex  | ModernCV Banking | ModernCV template with banking style                                |
| moderncv-casual     | latex  | ModernCV Casual  | ModernCV template with casual style                                 |
| moderncv-classic    | latex  | ModernCV Classic | ModernCV template with classic style                                |
| calm                | html   | Calm             | Clean and minimalist design suitable for all professionals.         |
| vscode              | html   | VS Code          | Dark theme inspired by Visual Studio Code, tailored for developers. |
| calm                | docx   | Calm             | Clean and minimalist design suitable for all professionals.         |

On this page