📦🐈 Active development trunk for Yarn ⚒
BSD 2-Clause "Simplified" License
5796
61
898

Yarn

Fast, reliable, and secure dependency management.

GitHub Actions status Discord Chat Latest CLI Release


Yarn is a modern package manager split into various packages. Its novel architecture allows to do things currently impossible with existing solutions:

  • Yarn supports plugins; adding a plugin is as simple as adding it into your repository
  • Yarn supports Node by default but isn't limited to it - plugins can add support for other languages
  • Yarn supports workspaces natively, and its CLI takes advantage of that
  • Yarn uses a bash-like portable shell to make package scripts portable across of Windows, Linux, and macOS
  • Yarn is first and foremost a Node API that can be used programmatically (via @yarnpkg/core)
  • Yarn is written in TypeScript and is fully type-checked

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.

But also

Datadog has been sponsoring the time from our lead maintainer for more than a year now. They also upgraded our account so that we can benefit from long-term telemetry (RFC).
Sysgears also sponsored time from very early in the 2.x development. In particular, their strong investment is the reason why Yarn 2 supports node_modules installs even better than it used to.
Netlify has been the historical provider for our website. Each time we got issues, they jumped to our help. Their live previews have been super helpful in our development process.
Cloudflare has also been a historical partner. While we don't directly mirror the npm registry anymore, they still power our website to make its delivery as fast as possible.
Algolia contributed a lot to our documentation over the years. They still power the search engine we use on both versions of the documentation.

Installation

Consult the Installation Guide.

Migration

Consult the Migration Guide.

Documentation

The documentation can be found at yarnpkg.com.

API

The API documentation can be found at yarnpkg.com/api.

Current status

On top of our classic integration tests, we also run Yarn every day against the latest versions of the toolchains used by our community - just in case. Everything should be green!

ToolchainsTooling

























Contributing

Consult the Contributing Guide.

Building your own bundle

Clone this repository, then run the following commands:

yarn build:cli

How it works

After building the CLI your global yarn will immediately start to reflect your local changes. This is because Yarn will pick up the yarnPath settings in this repository's .yarnrc.yml, which is configured to use the newly built CLI if available.

Works out of the box!

Note that no other command is needed! Given that our dependencies are checked-in within the repository (within the .yarn/cache directory), you don't even need to run yarn install. Everything just works right after cloning the project and is guaranteed to continue to work ten years from now 🙂

Yarn plugins

Default plugins

Those plugins typically come bundled with Yarn. You don't need to do anything special to use them.

Third-party plugins

Plugins can be developed by third-party entities. To use them within your applications, just specify the full plugin URL when calling yarn plugin import. Note that plugins aren't fetched from the npm registry at this time - they must be distributed as a single JavaScript file.

Creating a new plugin

To create your own plugin, please refer to the documentation.

Generic packages

The following packages are generic and can be used in a variety of purposes (including to implement other package managers, but not only):

Yarn packages

The following packages are meant to be used by Yarn itself, and probably won't be useful to other applications:

Contributors

arcanis
merceyz
paul-soporan
yarnbot
larixer
bgotink
deini
andreialecu
eps1lon
trivikr
Haroenv
jj811208
noahnu
ylemkimon
missing1984
willgriffiths
jdanil
Embraser01
lirantal
Ayc0
RDIL
elmpp
isker
eltociear
wojtekmaj
cometkim
darthtrevino
kherock
Larry1123
mhassan1
mskelton
martinjlowm
mrienstra
seansfkelley
stephank
7rulnik
yoannmoinet
zypA13510
lroling8350
Daniel15
elado
0xflotus
chengcyber
edvardchen
ganemone
bartocc
kiancross
kidonng
olingern
oliversalzburg
rlue
tapayne88
cuyl
zkochan
jeff-wishnie
colinaaa
JureSotosek
crubier
sargunv
waterfoul
PowerKiKi
stylemistake
MrEfrem
alizeait
amitdahan
andrewl33
niieani
borekb
eventualbuddha
colincasey
mollyIV
dmattia
Dongkyuuuu
dstaley
FrozenKiwi
hughdavenport
JLHwung
simnalamburt
jacobrask
jdlehman
juanpicado
kevin940726
touzoku
Andarist
accidentaldeveloper
ngryman
nicolo-ribaudo
LaRuaNa
ojkelly
chooban
rtsao
SamChou19815
Samantha-uk
tiansijie
teoxoy
jeysal
vhiairrassary
fulldecent
orzFly
bruce-one