yo

What is yo?

The 'yo' npm package, also known as Yeoman, is a robust tool for scaffolding projects. It helps developers quickly set up new projects with a predefined structure and best practices. Yo works by running generators, which are plugins that can be run with the 'yo' command to scaffold complete projects or useful parts.

What are yo's main functionalities?

Project Scaffolding

This command uses the 'webapp' generator to scaffold a new web application project. It sets up a basic project structure with HTML, CSS, and JavaScript files, along with build tools like Grunt or Gulp.

yo webapp

Custom Generators

You can create custom generators to scaffold specific types of projects or components. This command runs a custom generator named 'my-generator' to scaffold a project or component according to your specifications.

yo my-generator

Interactive Prompts

Running 'yo' without any arguments will list all available generators and prompt you to select one. It then guides you through a series of questions to customize the generated project.

yo

Other packages similar to yo

create-react-app

Create React App is a command-line tool to set up a new React project with a single command. It provides a modern build setup with no configuration. Compared to 'yo', it is more specialized for React applications and does not support custom generators.

vue-cli

Vue CLI is a standard tooling for Vue.js development. It offers a similar scaffolding experience to 'yo' but is focused on Vue.js projects. It provides a rich set of features like project templates, plugins, and a graphical user interface.

angular-cli

Angular CLI is a command-line interface tool that helps to initialize, develop, scaffold, and maintain Angular applications. It is similar to 'yo' but specifically tailored for Angular projects, offering commands to generate components, services, and other Angular-specific elements.

README

yo

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. A generator is basically a plugin that can be run with the yo command to scaffold complete projects or useful parts.

Usage

# install yo
npm install --global yo

# install a generator
npm install --global generator-webapp

# run it
yo webapp

To create and distribute your own generator, refer to our official documentation

You can also run a local generator on your computer as such:

# 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.
• --[no-]insight - Toggle anonymous Insight tracking which helps us improve Yeoman. Using either of these flags on the first run will prevent you from being prompted about it interactively. The flags can also be used to change it later on.
• --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.

Changelog

See the release page.

Backers

Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[Become a backer]

License

BSD-2-Clause © Google