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-resume

pnpm create yamlresume my-resume

yarn create yamlresume my-resume

bun create yamlresume my-resume

What it does

This tool will:

Create a new directory with your project name
Create a basic Node.js project structure with:
- package.json with YAMLResume dependency and useful scripts
- .gitignore file with appropriate excludes
- README.md with 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.

✔ 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

Project 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 PDF
npm run dev - Watch for changes and rebuild automatically
npm run validate - Validate your resume against the schema
npm run yamlresume - Run the YAMLResume CLI

Usage

What it does

Sample Session

Project Structure

Available Commands

On this page