create-yamlresume
create-yamlresume helps you create a new YAMLResume project with a one-liner command.
Usage
npx create-yamlresume my-resume
# or
npm init yamlresume my-resumepnpm create yamlresume my-resumeyarn create yamlresume my-resumebun create yamlresume my-resumeWhat it does
This tool will:
- Create a new directory with your project name
- Create a basic Node.js project structure with:
package.jsonwith YAMLResume dependency and useful scripts.gitignorefile with appropriate excludesREADME.mdwith basic usage instructions
- Install all necessary dependencies
- Create a new sample resume file using
yamlresume new - Show available commands and next steps
Sample Session
$ pnpm create yamlresume
✔ What is your project name? … yamlresume
ℹ Using pnpm. 4:40:46 PM
✔ What should your resume file be called? (without .yml extension) … resume
◐ Creating YAMLResume project in /private/tmp/yamlresume... 4:40:48 PM
◐ Installing dependencies with pnpm... 4:40:48 PM
✔ Dependencies installed successfully! 4:37:09 PM
◐ Creating resume file resume.yml... 4:37:09 PM
✔ Created resume.yml successfully. 4:37:10 PM
◐ Initializing git repository... 4:37:10 PM
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! 4:37:10 PM
[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! 4:37:10 PM
ℹ 4:37:10 PM
✨ Project created successfully!
ℹ 4:37:10 PM
Next steps:
ℹ 1. cd yamlresume 4:37:10 PM
ℹ 2. Edit your resume: resume.yml 4:37:10 PM
ℹ 3. Build your resume: pnpm run build 4:37:10 PM
ℹ 4. Watch for changes: pnpm run dev 4:37:10 PM
ℹ 5. Show all commands: pnpm run yamlresume help 4:37:10 PM
ℹ 4:37:10 PM
Learn more:
ℹ 🏠 Homepage: https://yamlresume.dev 4:37:10 PM
ℹ 📖 Documentation: https://yamlresume.dev/docs/ 4:37:10 PM
ℹ 🎨 Templates: https://yamlresume.dev/docs/layout/templates 4:37:10 PM
ℹ 📝 Schema: https://yamlresume.dev/docs/compiler/schemaProject Structure
The generated project looks like this:
my-resume/
├── package.json # Project configuration with yamlresume dependency
├── .gitignore # Git ignore rules
├── README.md # Project documentation
└── resume.yml # Your YAML resume (filename you choose)Available Commands
In the generated project, you can run:
npm run build- Build your resume to PDFnpm run dev- Watch for changes and rebuild automaticallynpm run validate- Validate your resume against the schemanpm run yamlresume- Run the YAMLResume CLI
Edit on GitHub
Last updated on