Skip to content
πŸ“¦πŸˆ The active development trunk for Yarn 2 βš’
TypeScript JavaScript Shell Prolog Dockerfile C
Branch: master
Clone or download
Pull request Compare This branch is 33 commits behind yarnpkg:master.

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
.yarn
docs
packages
scripts
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.pnp.js
.prettierignore
.yarnrc
.yarnrc.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
babel.config.js
constraints.pro
jest.config.js
package.json
plugins.yml
tsconfig.json
yarn.lock

README.md

Yarn

Fast, reliable, and secure dependency management.

GitHub Actions status Discord Chat Stable Release Prerelease


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 portable shell to execute package scripts, guaranteeing they work the same way on Windows and Linux
  • 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

Install

Consult the dedicated page for more details.

Documentation

The documentation is being reworked to contain an updated content and a refreshed design, and the most up-to-date version can be found on the repository GitHub pages: yarnpkg.com

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, really. Everything should be green!

ToolchainsTooling















Build 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.

Contrib plugins

Although developed on the same repository as Yarn itself, those plugins are optional and need to be explicitly installed through yarn plugin import @yarnpkg/<plugin-name>.

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:

You can’t perform that action at this time.