W3cubDocs

/Yarn

2. Installation

Before you start using Yarn, you'll first need to install it on your system. There is a growing number of different ways to install Yarn:

macOS

Homebrew

You can install Yarn through the Homebrew package manager. This will also install Node.js if it is not already installed.

brew update
brew install yarn

MacPorts

You can install Yarn through MacPorts. This will also install Node.js if it is not already installed.

sudo port install yarn

Path Setup

You will need to set up the PATH environment variable in your terminal to have access to Yarn’s binaries globally.

Add export PATH="$PATH:`yarn global bin`" to your profile (this may be in your .profile, .bashrc, .zshrc, etc.)

Windows

There are two options for installing Yarn on Windows.

Download the installer

This will give you a .msi file that when run will walk you through installing Yarn on Windows.

If you use the installer you will first need to install Node.js.

Download Installer

Install via Chocolatey

Chocolatey is a package manager for Windows, you can install Chocolatey by following these instructions.

Once you have Chocolatey installed, you may install yarn by running the following code in your console:

choco install yarn

This will also ensure that you have Node.js installed.

Notice

Please whitelist your project folder and the Yarn cache directory (%LocalAppData%\Yarn) in your antivirus software, otherwise installing packages will be significantly slower as every single file will be scanned as it’s written to disk.

Debian/Ubuntu Linux

On Debian or Ubuntu Linux, you can install Yarn via our Debian package repository. You will first need to configure the repository:

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

On Ubuntu 14.04 and Debian Stable, you will also need to configure the NodeSource repository to get a new enough version of Node.js (Debian Testing and Ubuntu 16.04 come packaged with a sufficient version of Node.js, so this step is not required in those environments)

Then you can simply:

sudo apt-get update && sudo apt-get install yarn

CentOS / Fedora / RHEL

On CentOS, Fedora and RHEL, you can install Yarn via our RPM package repository.

sudo wget https://dl.yarnpkg.com/rpm/yarn.repo -O /etc/yum.repos.d/yarn.repo

If you do not already have Node.js installed, you should also configure the NodeSource repository:

curl --silent --location https://rpm.nodesource.com/setup_6.x | bash -

Then you can simply:

sudo yum install yarn

Arch Linux

On Arch Linux yarn can be installed through the AUR.

If you use an AUR Helper such as yaourt you can simply run:

yaourt -S yarn

Solus

On Solus, you can install yarn via the Solus repository.

sudo eopkg install yarn

Path Setup

You will need to set up the PATH environment variable in your terminal to have access to Yarn’s binaries globally.

Add export PATH="$PATH:`yarn global bin`" to your profile (this may be in your .profile, .bashrc, .zshrc, etc.)

Alternatives

If you are using another OS or one of the other options specific to your OS will not work for you, there are a couple of alternatives. You will need to install Node.js if you don’t already have it installed.

On common Linux distributions such as Debian, Ubuntu and CentOS, it is recommended to install Yarn via our packages instead.

Installation Script

One of the easiest ways to install Yarn on macOS and generic Unix environments is via our shell script. You can install Yarn by running the following code in your terminal:

curl -o- -L https://yarnpkg.com/install.sh | bash

The installation process includes verifying a GPG signature. View the source on GitHub

You can also specify a version by running the following code in your terminal:

curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version [version]

See the releases for possible versions.

Manual Install via tarball

You can install Yarn by downloading a tarball and extracting it anywhere.

cd /opt
wget https://yarnpkg.com/latest.tar.gz
tar zvxf latest.tar.gz
# Yarn is now in /opt/yarn-[version]/

Install via npm

Note: Installation via npm is generally not recommended. npm is non-deterministic, packages are not signed, and npm does not perform any integrity checks other than a basic SHA1 hash, which is a security risk when installing system-wide apps.

For these reasons, it is highly recommended that you install Yarn through the installation method best suited to your operating system.

You can also install Yarn through the npm package manager if you already have it installed. If you already have Node.js installed then you should already have npm.

Once you have npm installed you can run:

npm install --global yarn

Path Setup

Unix/Linux/macOS

You will need to set up the PATH environment variable in your terminal to have access to Yarn’s binaries globally.

Add export PATH="$PATH:`yarn global bin`" to your profile (this may be in your .profile, .bashrc, .zshrc, etc.)

Windows

You will need to set up the PATH environment variable in your terminal to have access to Yarn’s binaries globally.

Add set PATH=%PATH%;C:\.yarn\bin to your shell environment.

Test that Yarn is installed by running:

yarn --version

Nightly Builds

Nightly builds are the latest and greatest versions of Yarn, built using the very latest Yarn source code. Nightly builds are useful to try new features or test bug fixes that have not yet been released as part of a stable release. However, these builds are not guaranteed to be stable and may have bugs.

See how to install nightly builds


Problems? If you are unable to install Yarn with any of these installers, please search through GitHub for an existing issue or open a new one.

Search for an existing issue · Open a new issue

© 2016–2017 Yarn Contributors
Licensed under the BSD License.
https://yarnpkg.com/en/docs/install