yo

7.0.1 verified Sat Apr 25 auth: no javascript

CLI tool for running Yeoman generators. v7.0.1 (2025) is the latest stable, requiring Node.js ^20.17.0 || >=22.9.0. Yo provides a unified interface to scaffold projects using Yeoman generator ecosystem. Key differentiators: tight integration with yeoman-environment and yeoman-generator, supports local and global generators, and offers a doctor command for troubleshooting. Alternatives like create-* packages are project-specific; yo is framework-agnostic. Release cadence is irregular but major versions (v5, v6, v7) updated dependencies (got, inquirer, meow) and dropped Node.js versions.

Common errors

error Error: Cannot find module 'yeoman-environment' ↓

cause Missing required dependency when using yo programmatically or via npx.

fix

Install yeoman-environment: npm install --save-dev yeoman-environment

error Error: Generator not found. Run `yo doctor` to troubleshoot. ↓

cause The generator is not installed or not in the lookup path.

fix

Install the generator globally: npm install -g generator-webapp. Or use --local-only for local generators.

error Error: The engine "node" is incompatible with this module. ↓

cause Node.js version lower than required (>=20.17.0 for yo v7).

fix

Upgrade Node.js to 20.17.0 or 22.9.0+

Warnings

breaking yo v7 requires Node.js ^20.17.0 or >=22.9.0; drops support for Node 18 and 19. ↓

fix Upgrade Node.js to 20.17.0+ or 22.9.0+.

breaking yo v6 dropped completion support and removed direct dependency on inquirer, relying on @yeoman/adapter. ↓

fix Update generator adapters to use @yeoman/adapter. Custom scripts using inquirer directly may need updates.

breaking yo v5 updated got to v11 and requires Node.js >=18.13.0. ↓

fix Update Node.js to 18.13.0+; check any custom HTTP logic for got v11 breaking changes.

deprecated yo v4 removed insight module for tracking; telemetry is no longer collected. ↓

fix No action needed; if you relied on insight, switch to your own analytics.

gotcha Running a globally installed generator requires yo to be installed globally as well. Mixing global and local installations can cause errors. ↓

fix Ensure yo and generators are installed in the same global prefix, or use npx with explicit version.

Install

npm install yo

yarn add yo

pnpm add yo

Imports

default (CLI run)
wrong
```
npx yo generator
```
correct
```
npm install --global yo && yo generator
```
Use global install for reliability; npx may cause version conflicts.
Programmatic API
wrong
```
import yo from 'yo'
```
correct
```
import { runGenerator } from 'yo'
```
Programmatic API is not well-documented; the package is primarily a CLI.
Environment
wrong
```
import { Environment } from 'yo'
```
correct
```
import { Environment } from 'yeoman-environment'
```
yo re-exports yeoman-environment indirectly; for advanced usage, import directly from yeoman-environment.

Quickstart

Shows basic usage: install yo globally, install a generator, and run it to scaffold a project. Also includes local generator and doctor commands.

// Install yo globally
// npm install --global yo

// Install a generator
// npm install --global generator-webapp

// Run the generator
// yo webapp

// To generate scaffold:
// yo

// To run a local generator:
// yo ./path/to/generator

// Troubleshoot:
// yo doctor