yo: the CLI that runs a doctor check before you have typed anything
CLI tool for running Yeoman generators
At a glance
- What is it?
- The Yeoman command line tool, published as a lib/ directory with 26 runtime dependencies, a postinstall hook that runs yeoman-doctor, and a troubleshooting policy that sends generator bugs back to the generator's own repository.
- Who is it for?
- Use yo to run a generator, not as a project template manager, and expect two behaviours the flags do not cover: a doctor check on every install and update, and an update notice check that comes from a runtime dependency. The five documented flags are the whole surface, and the only one that changes where generators are found is --local-only, which is what you want when a global install is shadowing your checkout.
- Can I use it commercially?
- Yes. BSD-2-Clause is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
- Is it still maintained?
- Yes. The repository last received commits 106 days ago.
- What is it written in?
- Mainly JavaScript, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.
Star history
- yeoman/yo3,966 ★ · +3
| Repository | 2026-09-24 | 2026-11-15 |
|---|---|---|
| yeoman/yo | 4k | 4k |
3 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
postinstall runs yodoctor, and no flag turns it off
The package runs a diagnostic on installation, before you have invoked anything. Two scripts in package.json do it:
"scripts": {
"postinstall": "yodoctor",
"postupdate": "yodoctor",So every `npm install --global yo` and every update executes yeoman-doctor, which is also a runtime dependency at ^6.0.0. The same command is the documented troubleshooting entry point, which means the first thing a new user meets from this package is its own diagnostic output. The option list in the README has five flags, `--no-color`, `--version`, `--help`, `--generators` and `--local-only`, and none of them disables the check. Whether the check is fast enough to be harmless is not something the repository says, because the README never mentions the hook at all; the behaviour is only visible in the scripts block.
The install path itself is three commands, and the middle one is the part people forget:
npm install --global yo
npm install --global generator-webapp
yo webappHomebrew is offered as the alternative, `brew install yo`, and a generator that lives on disk can be run by path, `yo ./path/to/local/generator`, which is the route that matters for anyone reviewing a generator before publishing it.
The published tarball is lib/ and nothing else
The files array in package.json is one entry long:
"files": [
"lib"
],with main set to lib and the binary mapped to lib/cli.js, so what npm installs is the lib directory. The screenshot, the test directory, the mocha configuration and the xo configuration never ship, which is the point of the field and also the reason the tests cannot be run against an installed copy. The package is `"type": "module"`, so the CommonJS mocha configuration at the top level has to keep its .cjs extension to be loadable at all.
One field in the same file is quietly inert. The lockfile in this repository is package-lock.json, so installs here go through npm, and npm does not read the resolutions field, which is Yarn's mechanism. The pin it carries, natives at 1.1.3, therefore applies to Yarn installs and not to the npm path the repository actually uses. Nothing in the README mentions resolutions, so a reader comparing the manifest to the lockfile will find one mechanism that no longer matches the other.
Twenty six runtime dependencies for one command
The dependency list is where the real shape of the tool shows. Six are the Yeoman ecosystem itself: @yeoman/adapter, @yeoman/types, yeoman-environment, yeoman-doctor, yeoman-character and yosay, the package that prints a message in ASCII speech. Four are about finding and identifying generators rather than running them: cli-list, npm-keyword, fullname and package-json, with read-package-up for reading manifests. Then a presentation layer of seven, chalk, figures, titleize, humanize-string, string-length, sort-on and meow for parsing the help text, plus parse-help to render it.
The last group is the interesting one for anyone deciding whether to depend on yo directly. update-notifier is a runtime dependency, and it is the package that checks the registry for a newer version and prints a notice, so the CLI reaches the network on its own schedule rather than only when you run something. open is there to launch a URL, configstore to keep a small amount of state on disk, cross-spawn to run the generator's process, global-agent for the global lookup, and root-check for the permission check that a global install needs. lodash is in the list too. None of that is scaffolding logic; it is the cost of the directory around it.
The linter runs before the tests, and coverage goes to coveralls
The test setup is four scripts and eight visible development dependencies:
"scripts": {
"coverage": "c8 report --reporter=text-lcov | coveralls",
"pretest": "xo",
"test": "c8 esmocha"
},xo is the linter and it runs as pretest, so a formatting or lint failure stops the suite before a single test executes, with its rules in xo.config.mjs. The runner is esmocha rather than mocha, paired with @node-loaders/esbuild, which is how the tests execute ES modules without a separate build step. Coverage is produced by c8 and the lcov report is piped straight into coveralls, which is what the coveralls badge at the top of the README reports on.
The remaining two development dependencies tell you what the tests are about. nock intercepts HTTP, and registry-url reads the registry URL, so the parts of the CLI that talk to npm are stubbed rather than called for real, which is the only way to test update-notifier and package-json without hitting the network. sinon is there for spies and stubs, and globals supplies the environment description. So the suite is written against a faked registry, and the update notice path is exercised as a mock.
Two of the five flags ask for the same list
The option list is short enough to read twice. `--no-color` disables colours and `--version` prints the yo version. The other three are about discovery. `--help` prints the yo help menu with the list of found generators, `--generators` prints available generators, and `--local-only` disables the lookup of globally-installed generators.
Found and available are two different words for what sounds like one list, and the README does not say what separates them, so a user comparing the two outputs has no documented way to interpret the difference. The resolution order is documented by implication rather than by rule: a generator on disk can be run by path, and --local-only exists, which means the global npm lookup happens by default. What is missing is the opposite flag, one that would suppress a local path in favour of the global lookup, and no option is offered to narrow the search to a namespace or a keyword even though npm-keyword is a dependency.
The two flags that matter most in practice are the quiet ones. --version and --local-only are what you reach for when the wrong generator ran, and --no-color is what you need when the output is being captured somewhere that renders the colour codes as text.
readme.md is lower case and the homepage is plain http
Small things in the tree are worth knowing before you file an issue. The readme at the top level is spelled readme.md in lower case, which matters on a case-sensitive filesystem even though it looks identical to the README.md GitHub serves. The homepage in package.json and in the badge row is http://yeoman.io, plain http rather than https. The package description uses the lower-case form, CLI tool for running Yeoman generators, and the author field says Yeoman while the licence line at the bottom of the readme reads BSD-2-Clause with Google as the copyright holder.
The rest of the surface is small and conventional: an .editorconfig, .gitattributes, .gitignore, a .github/ directory for the workflow and issue templates, the lib/ directory, test/, and screenshot.png. The badge row is six links, the npm version badge, the CI workflow, coveralls, a YouTube video, gitter, and an OpenCollective link, and the funding block below it is thirty backer slots, every one of them an empty anchor element in the file.
Generator bugs are routed to the generator
The troubleshooting section is three steps with a routing rule at the end. Run `yo doctor`. If that does not help, look through the open issues for the same symptom, and open a new one if it is not there. Every report has to carry two version numbers, the yo version from `yo --version` and the Node version from `node --version`.
The routing rule is the part that decides where your bug goes: if the problem only happens with one generator, the report belongs on that generator's repository, not on yo. The CLI positions itself as the layer that finds and launches generators, and everything that happens inside a generator run is the generator's own territory. That division is consistent with the dependency split, where the ecosystem packages are thin and the weight sits in discovery and presentation.
The release history fits the same narrow scope. Version 6.0.0 shipped on 2025-11-12, 7.0.0 on 2026-02-28 and 7.0.1 on 2026-04-09, and the changelog is not in this repository at all; the readme points at the release page on GitHub instead. The last push to main was 2026-08-01, four months after the 7.0.1 tag, so anything on the branch is ahead of what npm has.
Editorial conclusion
Use yo to run a generator, not as a project template manager, and expect two behaviours the flags do not cover: a doctor check on every install and update, and an update notice check that comes from a runtime dependency. The five documented flags are the whole surface, and the only one that changes where generators are found is --local-only, which is what you want when a global install is shadowing your checkout. Before filing anything, read the version numbers the troubleshooting section asks for, `yo --version` and `node --version`, because generator-level failures are explicitly routed to the generator's own repository. And check the version you have: 7.0.1 is the tag from 2026-04-09, and the branch was pushed to on 2026-08-01.
Frequently asked questions
What is Yeoman used for?
Yeoman is a generator ecosystem, and yo is its command line tool. A generator is a plugin that yo runs to scaffold complete projects or useful parts of them, which is what the webapp example in the README does. Yeoman's stated purpose is to help you kickstart new projects, prescribing best practices and tools. Mechanically yo installs generators globally, finds them by name, and runs one, or runs a generator from a path on disk with yo ./path/to/local/generator.
What does yo doctor check?
It is the documented troubleshooting entry point, and the README says to run it before searching the open issues. It also runs by itself: package.json sets both postinstall and postupdate to yodoctor, so the check fires on every global install and every update, and none of the five documented flags disables it.
How do I run a generator that is not installed globally?
Point yo at the path, for example yo ./path/to/local/generator, which is the form the README gives for a local generator. The flag --local-only goes further and disables the lookup of globally-installed generators entirely, which is how you stop a global install from shadowing the copy in your working tree.
What does the yo npm package actually ship?
Only lib. The files array in package.json contains a single entry, main is lib, and the yo binary maps to lib/cli.js, so the tests, the screenshot and the lint and mocha configurations stay out of the tarball. The package is type module, has 26 runtime dependencies, and carries a resolutions field pinning natives to 1.1.3, which is Yarn's mechanism and has no effect on the npm install path this repository's package-lock.json describes.
Which command line options does yo support?
Five: --no-color to disable colours, --version to print the current yo version, --help to print the help menu with the list of found generators, --generators to print available generators, and --local-only to disable the lookup of globally-installed generators. The README uses found and available as distinct terms without explaining the difference between the two lists.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/yeoman-yo)Star history chart for your README
[](https://hysenlabs.com/projects/yeoman-yo)Was this useful?