Skip to content
This repository

Note: The documentation below is for an older version of Yeoman and has been deprecated. Please instead see the Getting Started guide for information on how to install the latest version of Yeoman

Installation

Yeoman used to have an automated installer, which worked great on fresher systems, but had trouble with more used and configured systems. It has been officially deprecated, though is maintained at the Yeoman-scripts repo. It's recommended for people with less experience installing node, homebrew packages, etc. Below is the recommended installation route.

Audit script

The audit script can tell you what you're missing in order to install Yeoman. (Feel free to read the script source first, if you like). You can run it as many times are you want:

curl -L get.yeoman.io | bash

The script recommends how to install what's missing, but a more verbose description follows:

Yeoman Install Procedure

Windows

NOTE: Windows is not officially supported yet. Some things might not work!

To install Yeoman and its dependencies using Chocolatey:

1 | Open cmd & paste

C:> @powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('http://bit.ly/psChocInstall'))" && SET PATH=%PATH%;%systemdrive%\chocolatey\bin

2 | Type

c:> cinst yeoman

It will fetch & install all dependent files. Done!

Full instructions here, which includes how to install each component individually if Chocolatey doesn't work.

Mac & Linux

(Debian and ArchLinux users can check below).

  1. Use system package manager to install some necessary dependencies
    • On Mac, install Homebrew: ruby <(curl -fsSkL raw.github.com/mxcl/homebrew/go). After installing, run brew doctor and follow the recommendations.
    • Please brew update. Your formulae are likely outdated.
    • On Linux, you can use apt-get, yum, or up2date. Install jpegtran on linux using sudo apt-get install libjpeg-progs
  2. Install these packages if you don't already have them: git optipng jpeg-turbo phantomjs
    • git for obvious reasons, optipng and jpeg-turbo for image optimization in the build process. The PhantomJS install is used for a browser-run test suite.
  3. Confirm Ruby >= 1.8.7 is installed (ruby -v). If not, install it. (Ruby is used with Compass)
  4. Install latest 0.8.x NodeJS
    • Yeoman requires 0.8.x; running 0.6.x will cause problems.
    • We recommend downloading and installing the node binaries directly from nodejs.org. This will save you needing to compile from source.
  5. Install Compass stable
  6. Install Yeoman as a global node module: npm install yeoman -g. You may potentially need to run this with sudo

(Also, specific instructions for Debian users here).

(and for ArchLinux users, yeoman is present in AUR).

Requirements

Dependencies in list form:

  • NodeJS >= 0.8.x
  • Ruby >= 1.8.7
  • Compass >= 0.12.1
  • optipng
  • jpegtran
  • PhantomJS >= 1.6

Also, Homebrew is recommended on Mac to install phantomjs, jpegtran, optipng. It depends on Xcode CLI Tools.

Other procedures

For uninstall, reinstall, running an edge build, and other issues, see Additional FAQ

Something went wrong with that request. Please try again.