Fast, reliable, and secure dependency management.
Yarn is a modern package manager split into various packages. Its novel architecture allows to do things currently impossible with existing solutions:
Consult the Installation Guide.
Consult the Migration Guide.
The documentation can be found at yarnpkg.com.
The API documentation can be found at yarnpkg.com/api.
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!
Consult the Contributing Guide.
Clone this repository, then run the following commands:
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 🙂
Those plugins typically come bundled with Yarn. You don't need to do anything special to use them.
file:protocol within your dependencies.
portal:references as dependencies.
yarn npm info,
yarn npm login,
yarn npm publish, ...).
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>.
exec:protocol within your dependencies.
yarn workspaces foreachcommand.
Plugins can be developed by third-party entities. To use them within your applications, just specify the full plugin URL when calling
To create your own plugin, please refer to the documentation.
The following packages are generic and can be used in a variety of purposes (including to implement other package managers, but not only):
The following packages are meant to be used by Yarn itself, and probably won't be useful to other applications:
Generated using TypeDoc