Options
All
  • Public
  • Public/Protected
  • All
Menu

Yarn API

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 execute package scripts, guaranteeing they work the same way on 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

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.

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:

Generated using TypeDoc