YAMLResume

create-yamlresume

create-yamlresume vous aide à créer un nouveau projet YAMLResume avec une commande en une ligne.

Utilisation

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

Ce qu'il fait

Cet outil va :

  1. Créer un nouveau répertoire avec le nom de votre projet
  2. Créer une structure de projet Node.js de base avec :
    • package.json avec la dépendance YAMLResume et des scripts utiles
    • Fichier .gitignore avec les exclusions appropriées
    • README.md avec les instructions d'utilisation de base
  3. Installer toutes les dépendances nécessaires
  4. Créer un nouveau fichier de CV d'exemple en utilisant yamlresume new
  5. Afficher les commandes disponibles et les prochaines étapes

Session d'Exemple

$ 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

Structure du Projet

Le projet généré ressemble à ceci :

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)

Commandes Disponibles

Dans le projet généré, vous pouvez exécuter :

  • npm run build - Construire votre CV en PDF
  • npm run dev - Surveiller les changements et reconstruire automatiquement
  • npm run validate - Valider votre CV contre le schéma
  • npm run yamlresume - Exécuter le CLI YAMLResume
Edit on GitHub

Last updated on