YAMLResume

CLI

YAMLResume fournit un outil CLI pour vous aider à gérer votre CV. Vous pouvez suivre le guide d'installation pour l'installer.

YAMLResume CLI dans docker

Veuillez noter que nous avons une image docker pour vous, qui a le CLI yamlresume installé avec toutes les dépendances nécessaires.

Pour chaque sous-commande dans ce guide, vous pouvez l'exécuter dans docker en ajoutant la sous-commande après yamlresume/yamlresume.

Par exemple, pour créer un nouveau CV dans le CLI yamlresume :

yamlresume new my-resume.yml

Vous pouvez aussi l'exécuter dans docker avec :

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

Help

Afficher l'aide du CLI et toutes les commandes disponibles :

$ 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

Afficher la version du CLI YAMLResume :

$ yamlresume -V
0.15.3

New

Créer un nouveau CV. Le nom de fichier par défaut est resume.yml, mais vous pouvez spécifier un nom de fichier personnalisé :

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

Depuis la v0.15.0, yamlresume new crée votre CV à partir d'un exemple de CV sélectionné avec soin (par défaut, l'exemple software-engineer en anglais). Le fichier généré est fourni avec des commentaires YAML utiles pour la validation du schéma dans l'éditeur/l'IDE et un ensemble de layouts par défaut, afin que vous puissiez le compiler immédiatement.

--sample

Si vous voulez démarrer à partir d'un exemple de CV spécifique, utilisez l'option --sample. Exécutez yamlresume samples list pour voir tous les exemples disponibles :

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

Si un identifiant d'exemple inconnu est fourni, le CLI affiche tous les exemples disponibles pour vous aider à choisir :

$ 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

Tous les exemples de CV sont traduits en 12 langues locales. Vous pouvez utiliser l'option --language pour créer un CV à partir d'un exemple localisé, ce qui est très pratique pour rédiger des CV dans une autre langue que l'anglais :

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

Samples

YAMLResume est livré avec un ensemble d'exemples de CV sélectionnés avec soin pour des postes courants, traduits en 12 langues locales (de, en, es, fr, id, ja, nl, no, pt-br, zh-hans, zh-hant-hk, zh-hant-tw). Listez-les tous avec la sous-commande 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         |

Utilisez yamlresume new --sample <id> pour créer un nouveau fichier de CV à partir d'un exemple.

Build

Construire un CV de YAML vers PDF. Il générera le code LaTeX et le PDF en même temps, avec quelques fichiers intermédiaires .aux, .log etc, si vous utilisez XeTeX comme moteur de composition.

$ 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

Si vous voulez seulement générer le fichier LaTeX sans PDF, vous pouvez utiliser l'option --no-pdf.

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

--no-validate

Si vous voulez ignorer la validation du schéma de CV, vous pouvez utiliser l'option --no-validate.

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

--output

Si vous voulez spécifier un répertoire de sortie personnalisé pour les fichiers générés, vous pouvez utiliser l'option -o, --output.

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

--timeout

Si vous voulez personnaliser le délai d'attente pour la compilation LaTeX, vous pouvez utiliser l'option --timeout. Le délai d'attente par défaut est de 30 secondes. Vous pouvez désactiver le délai d'attente en le réglant sur 0.

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

Dev

Construire un CV de YAML vers PDF lors des changements de fichier. Il accepte les mêmes options que build mais il reconstruira automatiquement le CV quand le fichier YAML est modifié (mode surveillance). Ceci sera très pratique pour prévisualiser vos changements de CV en temps réel.

$ 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

Valider un CV contre le schéma 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

Par exemple, pour le CV suivant :

# 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 vous donnera une liste d'erreurs potentielles, avec des informations de position claires

$ 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

Vérifier votre environnement pour les dépendances YAMLResume. Cette commande aide à diagnostiquer les problèmes de configuration en vérifiant que tous les outils et polices requis sont correctement installés.

$ 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

La commande doctor vérifie :

  • Informations système : OS, architecture CPU
  • Binaires : Node.js, npm, pnpm, Yarn, Bun
  • Moteurs LaTeX : Disponibilité de XeTeX et Tectonic
  • Polices : Polices requises pour un rendu optimal du CV (Linux Libertine pour le texte latin, Noto CJK pour le chinois/japonais/coréen)

C'est particulièrement utile lors de la configuration de YAMLResume sur une nouvelle machine ou pour résoudre les problèmes de compilation de CV.

Languages

Lister toutes les langues disponibles. Le code de langue suit la spécification ISO 639. Vous pouvez spécifier le code de langue dans locale.language afin de changer la langue de votre CV. Changer la langue de votre CV traduira automatiquement tous les termes fixes. Vous pouvez vérifier plus de détails dans notre section contenu -> multi langues.

$ 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

Lister tous les modèles disponibles. Vous pouvez changer le modèle de CV en définissant layouts.[].template dans votre CV YAML. Modèles PPResume pour plus de détails.

$ 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.         |
Edit on GitHub

Last updated on

Installation

Previous Page

IA

Next Page

On this page

HelpNew--sample--languageSamplesBuild--no-pdf--no-validate--output--timeoutDevValidateDoctorLanguagesTemplates