create-yamlresume

O create-yamlresume ajuda-te a criar um novo projeto YAMLResume com um comando de uma linha.

Utilização

npx create-yamlresume my-resume

# ou

npm init yamlresume my-resume

pnpm create yamlresume my-resume

yarn create yamlresume my-resume

bun create yamlresume my-resume

O que faz

Esta ferramenta irá:

Criar um novo diretório com o nome do teu projeto
Criar uma estrutura básica de projeto Node.js com:
- package.json com dependência do YAMLResume e scripts úteis
- ficheiro .gitignore com exclusões apropriadas
- README.md com instruções básicas de utilização
Instalar todas as dependências necessárias
Criar um novo ficheiro de currículo de exemplo usando yamlresume new
Mostrar comandos disponíveis e próximos passos

Sessão de Exemplo

$ 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:   git config --global init.defaultBranch <name>

hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:

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/layouts/latex/templates
ℹ   📝 Schema: https://yamlresume.dev/docs/compiler/schema

Estrutura do Projeto

O projeto gerado apresenta-se assim:

my-resume/
├── package.json          # Configuração do projeto com dependência yamlresume
├── .gitignore            # Regras de ignore do Git
├── README.md             # Documentação do projeto
└── resume.yml            # O teu currículo YAML (nome de ficheiro que escolheres)

Comandos Disponíveis

No projeto gerado, podes executar:

npm run build - Construir o teu currículo para PDF
npm run dev - Vigiar alterações e reconstruir automaticamente
npm run validate - Validar o teu currículo contra o esquema
npm run yamlresume - Executar o CLI do YAMLResume

Utilização

O que faz

Sessão de Exemplo

Estrutura do Projeto

Comandos Disponíveis

On this page