Find file
Fetching contributors…
Cannot retrieve contributors at this time
187 lines (118 sloc) 8.06 KB

Welcome, Friend!

What am I?

Yeoman is a robust and opinionated client-side stack, comprised of tools and frameworks that can help developers quickly build beautiful web applications. We take care of providing everything needed to get started without any of the normal headaches associated with a manual setup.

Yeoman is fast, performant and is optimized to work best in modern browsers.

For more information about the project, see

Installing (pre-launch)

  • Clone this repo and cd into it
  • Run this command: ./setup/
  • cd into the /cli directory and run sudo npm link
  • Navigate to a new directory and run yeoman init to make sure everything is working as expected.

You can keep Yeoman up to date by using git pull --rebase upstream master && cd cli && npm link.

Make sure to pull in the latest and test before filing an issue, it might be fixed already Please also be sure to double-check an issue hasn't already been reported before submitting a new one


Yeoman supports a powerful set of high-level commands. These include:

yeoman init      # Initialize and scaffold a new project using generator templates
yeoman build     # Build an optimized version of your app, ready to deploy
yeoman server    # Launch a preview server which will begin watching for changes
yeoman test      # Run a Mocha test harness in a headless Phantom.js

yeoman install   # Install a package from the client-side package registry
yeoman uninstall # Uninstall the package
yeoman update    # Update a package to the latest version
yeoman list      # List the packages currently installed
yeoman search    # Query the registry for matching package names
yeoman lookup    # Look up info on a particular package

A common initial workflow with Yeoman might be:

yeoman init      # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
yeoman build     # Build your project, creating an optimized version in a new `dist` directory
yeoman server    # Fire off a file watch/server process which also places an 
                 # intermediate build of your project in `temp`

Some more examples of how to use our commands include:

# Generators for MVC/MV* Frameworks
yeoman init quickstart                   # Skip our questions and get a H5BP, jQuery and Modernizr base
yeoman init bbb                          # Backbone Boilerplate generator scaffold
yeoman init ember                        # Ember-Rails generator scaffold
yeoman init backbone                     # Backbone-Rails generator scaffold

# Coming soon
yeoman init angular                      # Invoke the AngularJS generator scaffold
yeoman init angular:controller           # Invoke the AngularJS Controller sub-generator

# Generator for Chrome Apps
yeoman init chromeapps

# Package management
yeoman search jquery                       # Lookup jQuery in the Bower registry
yeoman install jquery underscore [depName] # Install a dependency or dependencies
yeoman update jquery                       # Update a specific dependency (e.g jquery)

See the complete documentation for more. We also have extended documentation available for those more interested in the Yeoman internals.


If for any reason you experience exceptions after the yeoman installation process above, you may find the following steps resolve these issues:

cd yeoman/cli
sudo -s 'npm install -g && npm link'

Should you run into any further problems beyond this, please open a new issue and one of the team will be happy to follow up with you.


Please also note that (pre-launch) commands such as yeoman install, yeoman update and yeoman search etc (i.e package management commands) will only work if you have Bower installed.

Because for the moment Twitter are publishing Bower over itself (for 1.0.0 release) you may need to run npm uninstall yeoman -g && npm install yeoman -g to get the latest install of Bower installed as a Yeoman dependency. This would be done if you wish to double-check an issue has been resolved with a more recent version.

As the Bower registry is currently being populated, you may find that certain packages work and others do not. We are actively working with the Bower team to resolve this issue and hope to have fully functional packages in place upon launch.

As Bower is also currently in private beta, please let us know if you need access and we'll sort that out.

Browser Support

  • Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
  • Chrome on Android
  • Mobile Safari

Platform Support

Yeoman 1.0 will support OS X and Linux. We will be aiming to bring in support for Windows in a future version of the project.


We are more than happy to accept external contributions to the project in the form of feedback, bug reports and even better - pull requests :) At this time we are primarily focusing on improving the user-experience and stability of Yeoman for our first release. Please keep this in mind if submitting feature requests, which we're happy to consider for future versions.


Style Guide

This project follows the jQuery Style Guide with an exception of two space indentation and multiple var statements. Please ensure any pull requests follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this.

Pull Request Guidelines

  • Lint the code by running grunt in the /cli folder before submitting a pull request
  • Develop in a topic branch, not master


Yeoman has a test suite to ensure it's reliably and accurately working as a developer tool. You can find the main test suite in test/test-build.js, most of the assertions are checks against yeoman cli stdout.

To run our test suite:

npm test

Do note that if any CLI prompts are not accounted for the test suite will have a timeout failure.

Developer Docs

We have significant developer docs for you if you'd like to hack on Yeoman.

Currently you can find much of the details on mklabs' yeoman wiki but also our primary project.

You're also welcome to git blame back to commit messages and pull requests. As a project we value comprehensive discussion for our fellow developers.


Yeoman is an open-source project by Google which builds on top of Grunt and node-build-script. We utilize a number of useful open-source solutions including:

  • Twitter Bootstrap
  • HTML5 Boilerplate
  • Modernizr
  • Twitter Bower
  • Node.js
  • NPM
  • Compass
  • Socket.IO
  • CoffeeScript
  • Mocha
  • Jasmine
  • PhantomJS
  • And more...

Version 1 of the project features the combined efforts of:

and other developers.

We will be aiming to officially release the project in Q3, 2012.


If you've been invited to try out the project as a beta tester or contributor, all we ask is that you refrain from publicly publishing/sharing the project sources until we have launched. This is to ensure that the first public version of Yeoman is as stable as possible, but would also stop unicorns from crying. Thanks for understanding :)