# yo [![npm](https://badge.fury.io/js/yo.svg)](http://badge.fury.io/js/yo) [![Build Status](https://github.com/yeoman/yo/actions/workflows/ci.yml/badge.svg)](https://github.com/yeoman/yo/actions/workflows/ci.yml) [![Coverage Status](https://coveralls.io/repos/yeoman/yo/badge.svg)](https://coveralls.io/r/yeoman/yo) [![](https://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://www.youtube.com/watch?v=9auOCbH5Ns4) [![Gitter](https://img.shields.io/badge/Gitter-Join_the_Yeoman_chat_%E2%86%92-00d06f.svg)](https://gitter.im/yeoman/yeoman) [![OpenCollective](https://opencollective.com/yeoman/backers/badge.svg)](https://opencollective.com/yeoman#support) [![](https://raw.githubusercontent.com/yeoman/media/master/optimized/yeoman-masthead.png)](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)]