YAMLResume

create-yamlresume

create-yamlresume te ayuda a crear un nuevo proyecto YAMLResume con un comando de una sola línea.

Uso

npx create-yamlresume my-resume

# o

npm init yamlresume my-resume
pnpm create yamlresume my-resume
yarn create yamlresume my-resume
bun create yamlresume my-resume

Qué hace

Esta herramienta hará:

  1. Crear un nuevo directorio con el nombre de tu proyecto
  2. Crear una estructura básica de proyecto Node.js con:
    • package.json con dependencia de YAMLResume y scripts útiles
    • archivo .gitignore con exclusiones apropiadas
    • README.md con instrucciones básicas de uso
  3. Instalar todas las dependencias necesarias
  4. Crear un nuevo archivo de currículum de muestra usando yamlresume new
  5. Mostrar comandos disponibles y próximos pasos

Sesión de Ejemplo

$ pnpm create yamlresume
✔ What is your project name? … yamlresume
ℹ Using pnpm.

✔ What should your resume file be called? (without .yml extension) … resume
◐ Creating YAMLResume project in /private/tmp/yamlresume...
◐ Installing dependencies with pnpm...
Packages: +59
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Progress: resolved 59, reused 59, downloaded 0, added 59, done

dependencies:
+ yamlresume 0.7.5

Done in 4s using pnpm v10.6.3
✔ Dependencies installed successfully!
◐ Creating resume file resume.yml...
✔ Created resume.yml successfully.
◐ Initializing git repository...
hint: Using 'master' as the name for the initial branch. This default branch name
hint: is subject to change. To configure the initial branch name to use in all
hint: of your new repositories, which will suppress this warning, call:
hint:
hint:   git config --global init.defaultBranch <name>
hint:
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint:
hint:   git branch -m <name>
Initialized empty Git repository in /tmp/yamlresume/.git/
✔ Git repository initialized!
[master (root-commit) 53c6210] init a new YAMLResume project
 4 files changed, 421 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md
 create mode 100644 package.json
 create mode 100644 resume.yml
✔ Initial commit created!

✨ Project created successfully!

Next steps:
ℹ   1. cd yamlresume
ℹ   2. Edit your resume: resume.yml
ℹ   3. Build your resume: pnpm run build
ℹ   4. Watch for changes: pnpm run dev
ℹ   5. Show all commands: pnpm run yamlresume help

Learn more:
ℹ   🏠 Homepage: https://yamlresume.dev
ℹ   📖 Documentation: https://yamlresume.dev/docs/
ℹ   🎨 Templates: https://yamlresume.dev/docs/layout/templates
ℹ   📝 Schema: https://yamlresume.dev/docs/compiler/schema

Estructura del Proyecto

El proyecto generado se ve así:

my-resume/
├── package.json          # Configuración del proyecto con dependencia yamlresume
├── .gitignore            # Reglas de ignore de Git
├── README.md             # Documentación del proyecto
└── resume.yml            # Tu currículum YAML (nombre de archivo que elijas)

Comandos Disponibles

En el proyecto generado, puedes ejecutar:

  • npm run build - Construir tu currículum a PDF
  • npm run dev - Vigilar cambios y reconstruir automáticamente
  • npm run validate - Validar tu currículum contra el esquema
  • npm run yamlresume - Ejecutar el CLI de YAMLResume
Edit on GitHub

Last updated on