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:
  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

Afficher la version du CLI YAMLResume :

$ yamlresume -V
0.5.0

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:
  -h, --help  display help for command

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

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

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

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

layout:
  typography:
    fontSize: 13pt

yamlresume validate vous donnera une liste d'erreurs potentielles, avec des informations de position claires

$ 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:40:15: warning: font size option is invalid, it must be one of the following: ["10pt", "11pt", "12pt"]
    fontSize: 13pt
              ^
✖ Resume validation failed.

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

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

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

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

On this page