CLI

YAMLResume menyediakan alat CLI untuk membantu Anda mengelola resume. Anda dapat mengikuti panduan instalasi untuk menginstalnya.

YAMLResume CLI di docker

Perhatikan bahwa kami memiliki image docker untuk Anda, yang memiliki yamlresume CLI terinstal dengan semua dependensi yang diperlukan.

Untuk setiap sub-command dalam panduan ini, Anda dapat menjalankannya di docker dengan menambahkan sub-command setelah yamlresume/yamlresume.

Misalnya, untuk membuat resume baru di yamlresume CLI:

yamlresume new my-resume.yml

Anda juga dapat menjalankannya di docker dengan:

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

Help

Tampilkan bantuan CLI dan semua perintah yang tersedia:

$ 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] <resume-path>  build a resume to LaTeX and PDF
  dev [options] <resume-path>    build a resume on file changes (watch mode)
  languages                      i18n and l10n support
  templates                      manage resume templates
  validate <resume-path>         validate a resume against the YAMLResume schema
  help [command]                 display help for command

Tampilkan versi YAMLResume CLI:

$ yamlresume -V
0.5.0

New

Buat resume baru. Nama file resume default adalah resume.yml, tetapi Anda dapat menentukan nama file kustom:

$ 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 resume dari YAML ke PDF. Ini akan menghasilkan kode latex dan PDF pada saat yang sama, dengan beberapa file intermediate .aux, .log dll, jika Anda menggunakan XeTeX sebagai mesin typesetting.

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

build a resume to LaTeX and PDF

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

$ 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`

Jika Anda hanya ingin menghasilkan file LaTeX tanpa PDF, Anda dapat menggunakan opsi --no-pdf.

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

`--no-validate`

Jika Anda ingin melewati validasi schema resume, Anda dapat menggunakan opsi --no-validate.

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

Dev

Build resume dari YAML ke PDF saat file berubah. Ini menerima opsi yang sama dengan build namun akan secara otomatis membangun ulang resume saat file YAML diubah (alias, watch mode). Ini akan sangat nyaman bagi Anda untuk mempratinjau perubahan resume Anda secara real time.

$ 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

Validasi resume terhadap schema 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

Misalnya, untuk resume berikut:

# 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 akan memberi Anda daftar potensi kesalahan, dengan informasi posisi yang jelas

$ yamlresume validate my-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

Periksa lingkungan Anda untuk dependensi YAMLResume. Perintah ini membantu mendiagnosis masalah setup dengan memverifikasi bahwa semua alat dan font yang diperlukan terinstal dengan benar.

$ 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

Perintah doctor memeriksa:

Informasi sistem: OS, arsitektur CPU
Biner: Node.js, npm, pnpm, Yarn, Bun
Mesin LaTeX: Ketersediaan XeTeX dan Tectonic
Font: Font yang diperlukan untuk rendering resume optimal (Linux Libertine untuk teks Latin, Noto CJK untuk Mandarin/Jepang/Korea)

Ini sangat membantu saat menyiapkan YAMLResume di mesin baru atau memecahkan masalah build resume.

Languages

Daftar semua bahasa yang tersedia. Kode bahasa mengikuti spec dalam spesifikasi ISO 639. Anda dapat menentukan kode bahasa di locale.language untuk mengubah bahasa resume Anda. Mengubah bahasa resume Anda akan secara otomatis menerjemahkan semua istilah tetap. Anda dapat melihat lebih detail di bagian content -> multi languages kami.

$ yamlresume languages list

| locale.language | Language Name                   |                                                                                                                                                                                                                                                                                                           1:03:48 PM
| --------------- | ------------------------------- |
| 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                          |

Templates

Daftar semua template yang tersedia. Anda dapat mengubah template resume dengan mengatur layouts.[].template di resume YAML Anda. PPResume Templates untuk lebih detail.

$ yamlresume templates list

| layouts.[].template | Engine | Template Name    | Description                                       |
| ------------------- | ------ | ---------------- | ------------------------------------------------- |
| 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. |

On this page