https://github.com/yeoman/yo
CLI tool for running Yeoman generators
https://github.com/yeoman/yo
generator javascript nodejs scaffolding templates yeoman
Last synced: 6 months ago
JSON representation
CLI tool for running Yeoman generators
- Host: GitHub
- URL: https://github.com/yeoman/yo
- Owner: yeoman
- License: bsd-2-clause
- Created: 2013-02-11T13:24:05.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2025-04-19T04:23:59.000Z (7 months ago)
- Last Synced: 2025-04-22T11:37:21.741Z (7 months ago)
- Topics: generator, javascript, nodejs, scaffolding, templates, yeoman
- Language: JavaScript
- Homepage: http://yeoman.io
- Size: 2.81 MB
- Stars: 3,883
- Watchers: 105
- Forks: 406
- Open Issues: 48
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps - yo - Scaffolding tool for running Yeoman generators. (Development / Boilerplate)
- fucking-awesome-cli-apps - yo - Scaffolding tool for running Yeoman generators. (Development / Boilerplate)
- jimsghstars - yeoman/yo - CLI tool for running Yeoman generators (JavaScript)
- awesome-engineering - Yeoman
- awesome-engineering - Yeoman
README
# yo [](http://badge.fury.io/js/yo) [](https://github.com/yeoman/yo/actions/workflows/ci.yml) [](https://coveralls.io/r/yeoman/yo) [](https://www.youtube.com/watch?v=9auOCbH5Ns4) [](https://gitter.im/yeoman/yeoman) [](https://opencollective.com/yeoman#support)
[](http://yeoman.io)
## What's Yeoman?
Yeoman helps you to kickstart new projects, prescribing best practices and tools to help you stay productive.
To do so, we provide a [generator ecosystem](http://yeoman.io/generators/). A generator is basically a plugin that can be run with the `yo` command to scaffold complete projects or useful parts.
## Usage
```sh
# install yo
npm install --global yo
# install a generator
npm install --global generator-webapp
# run it
yo webapp
```
or via `brew`:
```sh
brew install yo
```
*To create and distribute your own generator, refer to [our official documentation](http://yeoman.io/authoring/)*
You can also run a local generator on your computer as such:
```sh
# Running a local generator
yo ./path/to/local/generator
```
## Options
- `--no-color` - Disable colors.
- `--version` - Print the current `yo` version.
- `--help` - Print `yo` help menu with the list of found generators.
- `--generators` - Print available generators.
- `--local-only` - Disable lookup of globally-installed generators.
## Troubleshooting
Running `yo doctor` command can help you troubleshoot common issues.
If `doctor` doesn't help, then check opened issues for a similar problem. Open a new issue if your problem haven't been reported yet. Make sure to always include the version of `yo` (`yo --version`) and Node.js (`node --version`) you use.
If your issue only occurs using a generator, please report the issues on the generator's repository.
## Contribute
See the [contributing docs](http://yeoman.io/contributing/).
## Changelog
See the [release page](https://github.com/yeoman/yo/releases).
## Backers
Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[[Become a backer](https://opencollective.com/yeoman#support)]
## License
BSD-2-Clause © Google