YAMLResume

CLI

O YAMLResume fornece uma ferramenta CLI para ajudá-lo a gerir o seu currículo. Pode seguir o guia de instalação para instalá-la.

CLI do YAMLResume em docker

Note que temos uma imagem de docker para si, que tem o CLI do yamlresume instalado com todas as dependências necessárias.

Para cada subcomando neste guia, pode executá-lo no docker adicionando o subcomando depois de yamlresume/yamlresume.

Por exemplo, para criar um novo currículo no CLI do yamlresume:

yamlresume new my-resume.yml

Também pode executá-lo no docker através de:

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

Help

Mostrar ajuda do CLI e todos os comandos disponíveis:

$ 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

Mostrar versão do CLI do YAMLResume:

$ yamlresume -V
0.5.0

New

Criar um novo currículo. O nome de ficheiro predefinido do currículo é resume.yml, mas pode especificar um nome de ficheiro personalizado:

$ 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

Construir um currículo de YAML para PDF. Irá gerar o código latex e o PDF ao mesmo tempo, com alguns ficheiros intermédios .aux, .log, etc., se usar XeTeX como motor de composição.

$ 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

Se apenas quiser gerar o ficheiro LaTeX sem PDF, pode usar a opção --no-pdf.

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

--no-validate

Se quiser omitir a validação do esquema do currículo, pode usar a opção --no-validate.

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

Dev

Construir um currículo de YAML para PDF em alterações de ficheiro. Aceita as mesmas opções que build no entanto reconstruirá automaticamente o currículo quando o ficheiro YAML mudar (isto é, modo de vigilância). Isto seria muito conveniente para que possa pré-visualizar as alterações do seu currículo em tempo real.

$ 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

Validar um currículo contra o esquema do 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

Por exemplo, para o seguinte currículo:

# 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

O yamlresume validate dar-lhe-á uma lista de erros potenciais, com informação posicional clara

$ 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

Verificar o seu ambiente para as dependências do YAMLResume. Este comando ajuda a diagnosticar problemas de configuração verificando que todas as ferramentas e fontes requeridas estão corretamente instaladas.

$ 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

O comando doctor verifica:

  • Informação do sistema: SO, arquitetura de CPU
  • Binários: Node.js, npm, pnpm, Yarn, Bun
  • Motores LaTeX: Disponibilidade de XeTeX e Tectonic
  • Fontes: Fontes requeridas para uma renderização ótima do currículo (Linux Libertine para texto latino, Noto CJK para chinês/japonês/coreano)

Isto é particularmente útil ao configurar o YAMLResume numa nova máquina ou solucionar problemas de compilação do currículo.

Languages

Listar todos os idiomas disponíveis. O código de idioma segue a especificação em ISO 639 specification. Pode especificar o código de idioma em locale.language para mudar o idioma do seu currículo. Mudar o idioma do currículo traduzirá automaticamente todos os termos fixos. Pode verificar mais detalhes na nossa secção content -> multi languages.

$ 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

Listar todos os modelos disponíveis. Pode mudar o modelo do currículo configurando layouts.[].template no seu currículo YAML. PPResume Templates para mais detalhes.

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

Last updated on

Instalação

Previous Page

Conteúdo

Next Page

On this page

Help
New
Build
--no-pdf
--no-validate
Dev
Validate
Doctor
Languages
Templates