yarn README

The project's README from github.com/yarnpkg/yarn. As one markdown file: README.md.

ℹ️ Important note

This repository holds the sources for Yarn 1.x (latest version at the time of this writing being 1.22). New releases (at this time the 3.2.3, although we're currently working on our next major) are tracked on the yarnpkg/berry repository, this one here being mostly kept for historical purposes and the occasional hotfix we publish to make the migration from 1.x to later releases easier.

If you hit bugs or issues with Yarn 1.x, we strongly suggest you migrate to the latest release - at this point they have been maintained longer than 1.x, and many classes of problems have already been addressed there. By using the nodeLinker setting you'll also have the choice of how you want to install your packages: node_modules like npm, symlinks like pnpm, or manifest files via Yarn PnP.

Fast, reliable, and secure dependency management.

Circle Status Appveyor Status Azure Pipelines status Discord Chat Commitizen friendly

Fast: Yarn caches every package it has downloaded, so it never needs to download the same package again. It also does almost everything concurrently to maximize resource utilization. This means even faster installs.

Reliable: Using a detailed but concise lockfile format and a deterministic algorithm for install operations, Yarn is able to guarantee that any installation that works on one system will work exactly the same on another system.

Secure: Yarn uses checksums to verify the integrity of every installed package before its code is executed.

Features

Our supports

Gold sponsors

All your environment variables, in one place. Stop struggling with scattered API keys, hacking together home-brewed tools, and avoiding access controls. Keep your team and servers in sync with Doppler.
Your app, enterprise-ready. Start selling to enterprise customers with just a few lines of code. Add Single Sign-On (and more) in minutes instead of months with WorkOS.

Installing Yarn

Read the Installation Guide on our website for detailed instructions on how to install Yarn.

Using Yarn

Read the Usage Guide on our website for detailed instructions on how to use Yarn.

Contributing to Yarn

The 1.x codebase is fairly old and will only accept security fixes. For new features or bugfixes, please see our new repository and its contribution guide.

Prior art

Yarn wouldn't exist if it wasn't for excellent prior art. Yarn has been inspired by the following projects:

Credits

Thanks to Sam Holmes for donating the npm package name!

yarn (yarnpkg/yarn)

yarn
Searching Database…

41.5K ·GitHub
Yarn
What is this?Yarn 1.x is a fast, reliable and secure dependency manager for JavaScript projects — a command-line tool that installs your project's packages as an alternative to npm.
Is this a tool I install on my machine, or a library my code imports?It's a tool you install on your machine and run from the terminal in your project directory; your code never imports it.
Do I need Node.js to run it?Yes — it's a JavaScript tool built on Node.js; the source targets Node 4.0.0 and up.
Is this version still maintained?No — the 1.x line is frozen: this repo only gets occasional hotfixes and security fixes, while all new features and bugfixes happen in the yarnpkg/berry repository.
Can I install my dependencies without an internet connection?Yes — offline mode lets you install again any package you've installed before, with no internet connection.
Why did the team build Yarn when npm already existed?Yarn took inspiration from npm, Bundler and Cargo and focused on speed (caching every downloaded package, running installs concurrently), network resilience (automatic retries) and duplicate-free dependency trees via Flat Mode.
What is Flat Mode?It resolves mismatched versions of a dependency to a single version, so duplicates of the same package don't pile up in your project.
What does current Yarn look like, now that 1.x is frozen?New releases (3.x at README time) live in the yarnpkg/berry repo, and the nodeLinker setting lets you choose how packages are installed: node_modules like npm, symlinks like pnpm, or manifest files via Yarn PnP.
What are similar projects?cli, liteparse, upm, bashka, npm, pip, nub, verdaccio
Which topics is it in?yarn, caching, package-manager, installer, offline, deprecated, developers, performance, free, security, npm, terminal
Creator
yarnpkg
Size
117 MB
Stars
41.5K
Updated
CommitFeb 12Releasev1.22.22Mar 09
Age
10y
Commits · 90 Days