CheatPress

Yarn Node package manager

Version 4.18.1 · source

Yarn, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Yarn, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Yarn, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Yarn, A5, light preview Light · A5 148 × 210 mm · PDF Yarn, A5, dark preview Dark · A5 148 × 210 mm · PDF Yarn, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Yarn, A4, light preview Light · A4 210 × 297 mm · PDF Yarn, A4, dark preview Dark · A4 210 × 297 mm · PDF Yarn, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Yarn, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Yarn, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Yarn, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Yarn, A3, light preview Light · A3 297 × 420 mm · PDF Yarn, A3, dark preview Dark · A3 297 × 420 mm · PDF Yarn, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Yarn, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Yarn, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Yarn, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Yarn, Letter, light preview Light · Letter 8.5 × 11 in · PDF Yarn, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Yarn, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Yarn, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Yarn, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Yarn, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

yarn install
Install all dependencies
yarn add <pkg>
Add a dependency
yarn remove <pkg>
Remove a dependency
yarn run <script>
Run a package script
yarn dlx <pkg>
Run a package once
yarn up <pkg>
Upgrade a dependency
yarn workspaces foreach -A run <script>
Run in every workspace
yarn install --immutable
Clean install for CI

Concepts

  1. package.json ranges you want
  2. yarn.lock exact versions
  3. Cache zipped packages
  4. Install PnP or node_modules

Install and add

yarn install
Install all dependencies
yarn add <pkg>
Add a dependency
yarn add -D <pkg>
Add a dev dependency
yarn add <pkg>@<version>
Add a specific version or tag
yarn add -E <pkg>
Save the exact version
yarn install --immutable
Fail if the lockfile would change
Already the default on CI, so a plain yarn install behaves the same there.
yarn install --mode=skip-build
Install without running build scripts

Remove and update

yarn remove <pkg>
Remove a dependency
yarn up <pkg>
Upgrade a package
yarn up "<pkg>@^2"
Upgrade to a given range
yarn up "*"
Upgrade everything
yarn up -i
Pick upgrades interactively
yarn dedupe
Merge duplicate versions in the lockfile
yarn set version stable
Pin the latest stable Yarn
yarn set version <version>
Pin an exact Yarn version

Run scripts

yarn run <script>
Run a package script
yarn <script>
Shorthand for yarn run
Built-in commands win when a script has the same name; use yarn run then.
yarn run <script> <args>
Pass arguments to a script
yarn run <bin>
Run a dependency's binary
yarn dlx <pkg> [args]
Fetch and run without installing
yarn dlx -p <pkg> <cmd>
Run a command from a package
yarn exec <cmd>
Run a shell command in the Yarn environment
yarn node <file>
Run Node with Yarn's loader
yarn init
Create a package.json
yarn init -w
Create a workspace root

Inspect

yarn info <pkg>
Show info about a package
yarn info <pkg> --dependents
Show who depends on a package
yarn why <pkg>
Show why a package is installed
yarn npm audit
Check for known vulnerabilities
yarn config
Show the current settings
yarn config get <key>
Read a setting

Workspaces

yarn workspaces list
List all workspaces
yarn workspace <name> <cmd>
Run a command in one workspace
yarn workspace <name> add <pkg>
Add a dependency to one workspace
yarn workspaces foreach -A run <script>
Run in every workspace
yarn workspaces foreach -Apt run <script>
Parallel, dependencies first
yarn workspaces foreach -R run <script>
Current workspace and its dependencies
yarn workspaces foreach --since=<ref> -A run <script>
Only workspaces changed since a ref
yarn workspaces foreach --exclude <glob> -A <cmd>
Skip workspaces matching a glob
yarn workspaces focus <name>
Install one workspace and its dependencies
Workspaces in package.json
{  "private": true,  "workspaces": ["packages/*"]}

Config, patching and publishing

yarn config set <key> <value>
Write a project setting
yarn cache clean
Delete the local cache
yarn patch <pkg>
Extract a package to edit
yarn patch-commit -s <dir>
Save the edits as a patch
yarn link <path>
Link a local project in
yarn npm publish
Publish the workspace
yarn npm publish --access public
Publish a scoped package publicly
.yarnrc.yml
nodeLinker: node-modulesnpmRegistryServer: "https://registry.npmjs.org"enableTelemetry: false

Recipes

Start a project
yarn set version stableyarn inityarn add expressyarn add -D typescript vitestyarn run test
CI install and test
yarn install --immutableyarn workspaces foreach -Apt run buildyarn workspaces foreach -A run test
Test only what changed
yarn workspaces foreach -A --since=origin/main run test
Patch a dependency
yarn patch <pkg># edit the printed folderyarn patch-commit -s <dir>