CLI
Referencia de todos los subcomandos de yamlresume: new, build, validate, templates list, languages list, samples list y más.
YAMLResume proporciona una herramienta CLI para ayudarte a gestionar tu currículum. Puedes seguir la guía de instalación para instalarla.
CLI de YAMLResume en docker
Ten en cuenta que tenemos una imagen de docker
para ti, que tiene el CLI de yamlresume instalado con todas las
dependencias necesarias.
Para cada subcomando en esta guía, puedes ejecutarlo en docker agregando el
subcomando después de yamlresume/yamlresume.
Por ejemplo, para crear un nuevo currículum en el CLI de yamlresume:
yamlresume new my-resume.ymlTambién puedes ejecutarlo en docker mediante:
docker run --rm -v $(pwd):/home/yamlresume yamlresume/yamlresume new my-resume.ymlHelp
Mostrar ayuda del CLI y todos los comandos 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,
LaTeX/PDF or Typst/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 commandMostrar versión del CLI de YAMLResume:
$ yamlresume -V
0.18.0New
Crear un nuevo currículum. El nombre de archivo predeterminado del currículum es
resume.yml, pero puedes especificar un nombre de archivo personalizado:
$ 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.Desde la v0.15.0, yamlresume new crea tu currículum a partir de un
currículum de ejemplo seleccionado (el predeterminado es el ejemplo
software-engineer en inglés). El archivo generado incluye comentarios YAML
útiles para la validación del esquema en editores/IDE y un conjunto de layouts
predeterminados, para que puedas construirlo de inmediato.
--sample
Si quieres empezar desde un currículum de ejemplo específico, usa la opción
--sample. Ejecuta yamlresume samples list para ver todos los
ejemplos disponibles:
$ yamlresume new ux-designer.yml --sample ux-designer
✔ Created ux-designer.yml from sample "ux-designer" successfully.Si se proporciona un id de ejemplo desconocido, el CLI imprime todos los ejemplos disponibles para ayudarte a elegir:
$ yamlresume new my-resume.yml --sample no-such-sample
ERROR Sample resume not found: no-such-sample
ℹ Available samples:
- account-executive: Account Executive
- ai-engineer: AI Engineer
- business-analyst: Business Analyst
- customer-success-manager: Customer Success Manager
- cybersecurity-engineer: Cybersecurity Engineer
- data-analyst: Data Analyst
- data-engineer: Data Engineer
- data-scientist: Data Scientist
- devops-engineer: DevOps Engineer
- financial-analyst: Financial Analyst
- human-resources-manager: Human Resources Manager
- marketing-manager: Marketing Manager
- mechanical-engineer: Mechanical Engineer
- operations-manager: Operations Manager
- product-manager: Product Manager
- project-manager: Project Manager
- qa-engineer: QA Engineer
- registered-nurse: Registered Nurse
- software-engineer: Software Engineer
- ux-designer: UX Designer--language
Los 20 currículums de ejemplo están traducidos a 13 idiomas regionales. Puedes
usar la opción --language para crear un currículum a partir de un ejemplo
localizado, lo cual es muy útil para escribir currículums en idiomas distintos
del inglés:
$ yamlresume new my-resume.yml --sample software-engineer --language zh-hans
✔ Created my-resume.yml successfully.Samples
YAMLResume incluye 20 currículums de ejemplo seleccionados para puestos comunes,
cada uno traducido a 13 idiomas (de, en, es, fr, id, it, ja, nl,
no, pt-br, zh-hans, zh-hant-hk, zh-hant-tw). Enuméralos todos con el
subcomando 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 |
| ------------------------ | ------------------------ | ------------------------ | ---------------- |
| account-executive | account executive | Account Executive | Sales |
| ai-engineer | ai engineer | AI Engineer | Engineering |
| business-analyst | business analyst | Business Analyst | Business |
| customer-success-manager | customer success manager | Customer Success Manager | Customer Success |
| cybersecurity-engineer | cybersecurity engineer | Cybersecurity Engineer | Engineering |
| data-analyst | data analyst | Data Analyst | Data Analytics |
| data-engineer | data engineer | Data Engineer | Engineering |
| data-scientist | data scientist | Data Scientist | Data Science |
| devops-engineer | devops engineer | DevOps Engineer | Engineering |
| financial-analyst | financial analyst | Financial Analyst | Finance |
| human-resources-manager | human resources manager | Human Resources Manager | Human Resources |
| marketing-manager | marketing manager | Marketing Manager | Marketing |
| mechanical-engineer | mechanical engineer | Mechanical Engineer | Engineering |
| operations-manager | operations manager | Operations Manager | Operations |
| product-manager | product manager | Product Manager | Product |
| project-manager | project manager | Project Manager | Management |
| qa-engineer | qa engineer | QA Engineer | Engineering |
| registered-nurse | registered nurse | Registered Nurse | Healthcare |
| software-engineer | software engineer | Software Engineer | Engineering |
| ux-designer | ux designer | UX Designer | Design |Usa yamlresume new --sample <id> para crear un nuevo archivo de
currículum a partir de un ejemplo.
Build
Construir todos los layouts configurados en un currículum YAML. Un solo comando
puede generar salidas DOCX, HTML, Markdown, LaTeX/PDF y Typst/PDF. Los layouts
LaTeX y Typst también producen el código fuente .tex y .typ. XeTeX puede
dejar archivos intermedios como .aux y .log.
Cuando se configuran ambos motores PDF, sus salidas usan nombres distintos:
resume.tex.pdf para LaTeX y resume.typ.pdf para Typst. Con un solo motor
PDF, la salida conserva el nombre histórico resume.pdf.
$ yamlresume build --help
Usage: yamlresume build [options] <resume-path>
build a resume to Docx, HTML, Markdown, LaTeX/PDF or Typst/PDF
Arguments:
resume-path the resume file path
Options:
--no-pdf only generate source files (TeX/Typst) without PDF
--no-validate skip resume schema validation
-o, --output <dir> output directory for generated files
-t, --timeout <seconds> timeout for LaTeX/Typst 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 solo quieres generar los archivos fuente de LaTeX y Typst sin PDF, usa la
opción --no-pdf.
$ yamlresume build --no-pdf my-resume.yml--no-validate
Si quieres omitir la validación del esquema del currículum, puedes usar la
opción --no-validate.
$ yamlresume build --no-validate my-resume.yml--output
Si quieres especificar un directorio de salida personalizado para los archivos
generados, puedes usar la opción -o, --output.
$ yamlresume build -o ./output my-resume.yml--timeout
Si quieres personalizar el tiempo de espera para la compilación LaTeX o Typst,
usa la opción --timeout. El tiempo de espera predeterminado es 30 segundos.
Puedes desactivar el tiempo de espera estableciéndolo en 0.
$ yamlresume build --timeout 60 my-resume.ymlDev
Construir un currículum de YAML a PDF en cambios de archivo. Acepta las mismas
opciones que build sin embargo reconstruirá automáticamente el
currículum cuando el archivo YAML cambie (es decir, modo vigilancia). Esto sería
muy conveniente para que puedas previsualizar los cambios de tu currículum en
tiempo 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 commandValidate
Validar un currículum contra el esquema de 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 commandPor ejemplo, para el siguiente currículum:
# 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: 13ptyamlresume validate te dará una lista de errores potenciales, con información
posicional clara
$ 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
Verificar tu entorno para las dependencias de YAMLResume. Este comando ayuda a diagnosticar problemas de configuración verificando que todas las herramientas y fuentes requeridas estén correctamente 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 Typst...
Typst: typst 0.15.1
ℹ Checking Fonts...
Linux Libertine O: Not Installed
Linux Libertine: Installed
Noto Serif CJK SC: Installed
Noto Sans CJK SC: InstalledEl comando doctor verifica:
- Información del sistema: SO, arquitectura de CPU
- Binarios: Node.js, npm, pnpm, Yarn, Bun
- Motores LaTeX: Disponibilidad de XeTeX y Tectonic
- Typst: Disponibilidad de Typst y la versión mínima 0.13.0
- Fuentes: Fuentes requeridas para una renderización óptima del currículum (Linux Libertine para texto latino, Noto CJK para chino/japonés/coreano)
Esto es particularmente útil al configurar YAMLResume en una nueva máquina o solucionar problemas de compilación del currículum.
Languages
Listar todos los idiomas disponibles. El código de idioma sigue la
especificación en ISO 639
specification. Puedes especificar el
código de idioma en locale.language para cambiar el idioma de tu
currículum. Cambiar el idioma de tu currículum traducirá automáticamente todos
los términos fijos. Puedes verificar más detalles en nuestra sección content ->
multi languages.
$ 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 |
| it | Italian |
| no | Norwegian |
| nl | Dutch |
| ja | Japanese |
| de | German |
| id | Indonesian |
| pt-br | Brazilian Portuguese |Templates
Listar todas las plantillas disponibles. Puedes cambiar la plantilla del
currículum configurando layouts.[].template en tu currículum YAML. PPResume
Templates para más detalles.
$ 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. |
| kami | html | Kami | Warm parchment and serif typography inspired by tw93/kami. |
| 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. |
| jake | typst | Jake's Resume | A simple, straight-forward resume template based on Jake's Resume |Last updated on