YARN(1)

✨ NAME ✨

yarn — Yarn: Fast, reliable, and secure dependency management. That's the official tagline, and honestly? It ate. 💅

💖 DESCRIPTION 💖

Okay bestie, so this whole page is about the Yarn Package Manager, version 4.0.1. The main-character invocation is literally just:

yarn <command>

Then we got a whole menu of commands, grouped by vibe. Let's go. ✨

---

🌸 General commands 🌸

• yarn add — add dependencies to the project. Like adding new faves to the group chat, but for packages. 💖

yarn add [--json] [-F,--fixed] [-E,--exact] [-T,--tilde] [-C,--caret] [-D,--dev] [-P,--peer] [-O,--optional] [--prefer-dev] [-i,--interactive] [--cached] [--mode #0] ...

• yarn bin — get the path to a binary script. Need the exact location? Say less. 📍

yarn bin [-v,--verbose] [--json] [name]

• yarn cache clean — remove the shared cache files. Bye bye, cache clutter. 🧹

yarn cache clean [--mirror] [--all]

• yarn config — display the current configuration. Show me the settings, bestie. 👀

yarn config [--no-defaults] [--json] ...

• yarn config get — read a configuration settings. Get that one config value. 🔍

yarn config get [--why] [--json] [--no-redacted] <name>

• yarn config set — change a configuration settings. Change it up. ✨

yarn config set [--json] [-H,--home] <name> <value>

• yarn config unset — unset a configuration setting. Poof, gone. 💅

yarn config unset [-H,--home] <name>

• yarn dedupe — deduplicate dependencies with overlapping ranges. Clean up the overlap, no cap. 🧼

yarn dedupe [-s,--strategy #0] [-c,--check] [--json] [--mode #0] ...

• yarn dlx — run a package in a temporary environment. Temporary, like my attention span. 💀

yarn dlx [-p,--package #0] [-q,--quiet] <command> ...

• yarn exec — execute a shell script. Run it. 🔥

yarn exec <commandName> ...

• yarn explain — explain an error code. Yarn therapy session. 😭

yarn explain [--json] [code]

• yarn explain peer-requirements — explain a set of peer requirements. Peer pressure, explained. 👑

yarn explain peer-requirements [hash]

• yarn info — see information related to packages. Spill the tea. 🍵

yarn info [-A,--all] [-R,--recursive] [-X,--extra #0] [--cache] [--dependents] [--manifest] [--name-only] [--virtuals] [--json] ...

• yarn init — create a new package. New package, who dis? 🎀

yarn init [-p,--private] [-w,--workspace] [-i,--install] [-n,--name #0]

• yarn install — install the project dependencies. The classic. Install szn. 📦

yarn install [--json] [--immutable] [--immutable-cache] [--refresh-lockfile] [--check-cache] [--check-resolutions] [--inline-builds] [--mode #0]

• yarn link — connect the local project to another one. Link up. 🔗

yarn link [-A,--all] [-p,--private] [-r,--relative] ...

• yarn node — run node with the hook already setup. Node, but pre-hooked. 🪝

yarn node ...

• yarn npm audit — perform a vulnerability audit against the installed packages. Security check, periodt. 🛡️

yarn npm audit [-A,--all] [-R,--recursive] [--environment #0] [--json] [--no-deprecations] [--severity #0] [--exclude #0] [--ignore #0]

• yarn pack — generate a tarball from the active workspace. Tarball time. 🎁

yarn pack [--install-if-needed] [-n,--dry-run] [--json] [-o,--out #0]

• yarn patch — prepare a package for patching. Patch it up. 🩹

yarn patch [-u,--update] [--json] <package>

• yarn patch-commit — generate a patch out of a directory. Commit that patch. 💾

yarn patch-commit [-s,--save] <patchFolder>

• yarn rebuild — rebuild the project's native packages. Rebuild era. 🔨

yarn rebuild ...

• yarn remove — remove dependencies from the project. Unstan. 🚫

yarn remove [-A,--all] [--mode #0] ...

• yarn run — run a script defined in the package.json. Script go brrr. 🏃

yarn run [--inspect] [--inspect-brk] [-T,--top-level] [-B,--binaries-only] [--require #0] <scriptName> ...

• yarn set resolution — enforce a package resolution. Enforce it, period. ⚖️

yarn set resolution [-s,--save] <descriptor> <resolution>

• yarn set version — lock the Yarn version used by the project. Lock it in. 🔒

yarn set version [--yarn-path] [--only-if-needed] <version>

• yarn set version from sources — build Yarn from master. Build from source, main character energy. 🛠️

yarn set version from sources [--path #0] [--repository #0] [--branch #0] [--plugin #0] [-n,--dry-run] [--no-minify] [-f,--force] [--skip-plugins]

• yarn stage — add all yarn files to your vcs. Stage it. 🎬

yarn stage [-c,--commit] [-r,--reset] [-n,--dry-run]

• yarn unlink — disconnect the local project from another one. Unlink, bye. 👋

yarn unlink [-A,--all] ...

• yarn unplug — force the unpacking of a list of packages. Unplug it. 🔌

yarn unplug [-A,--all] [-R,--recursive] [--json] ...

• yarn up — upgrade dependencies across the project. Glow-up for deps. ⬆️

yarn up [-i,--interactive] [-F,--fixed] [-E,--exact] [-T,--tilde] [-C,--caret] [-R,--recursive] [--mode #0] ...

• yarn why — display the reason why a package is needed. Why tho? 🤔

yarn why [-R,--recursive] [--json] [--peers] <package>

---

🌸 Constraints-related commands 🌸

• yarn constraints — check that the project constraints are met. Rules are rules. 📏

yarn constraints [--fix] [--json]

• yarn constraints query — query the constraints fact database. Query szn. 🔎

yarn constraints query [--json] <query>

• yarn constraints source — print the source code for the constraints. Source code reveal. 📜

yarn constraints source [-v,--verbose]

---

🌸 Interactive commands 🌸

• yarn search — open the search interface. Search interface, let's go. 🔍

yarn search

• yarn upgrade-interactive — open the upgrade interface. Interactive upgrade, cute. 🎮

yarn upgrade-interactive

---

🌸 Npm-related commands 🌸

• yarn npm info — show information about a package. Npm tea. ☕

yarn npm info [-f,--fields #0] [--json] ...

• yarn npm login — store new login info to access the npm registry. Login time. 🔐

yarn npm login [-s,--scope #0] [--publish] [--always-auth]

• yarn npm logout — logout of the npm registry. Logout, bye. 🚪

yarn npm logout [-s,--scope #0] [--publish] [-A,--all]

• yarn npm publish — publish the active workspace to the npm registry. Publish it, slay. 🚀

yarn npm publish [--access #0] [--tag #0] [--tolerate-republish] [--otp #0]

• yarn npm tag add — add a tag for a specific version of a package. Tag it. 🏷️

yarn npm tag add <package> <tag>

• yarn npm tag list — list all dist-tags of a package. List the tags. 📋

yarn npm tag list [--json] [package]

• yarn npm tag remove — remove a tag from a package. Tag removed. ❌

yarn npm tag remove <package> <tag>

• yarn npm whoami — display the name of the authenticated user. Who am I? 👤

yarn npm whoami [-s,--scope #0] [--publish]

---

🌸 Plugin-related commands 🌸

• yarn plugin check — find all third-party plugins that differ from their own spec. Plugin vibe check. ✅

yarn plugin check [--json]

• yarn plugin import — download a plugin. Import that plugin. 📥

yarn plugin import [--checksum] <name>

• yarn plugin import from sources — build a plugin from sources. Build from source. 🏗️

yarn plugin import from sources [--path #0] [--repository #0] [--branch #0] [--no-minify] [-f,--force] <name>

• yarn plugin list — list the available official plugins. Official plugin list. 📃

yarn plugin list [--json]

• yarn plugin remove — remove a plugin. Plugin out. 🗑️

yarn plugin remove <name>

• yarn plugin runtime — list the active plugins. Active plugins, let's see. ⚡

yarn plugin runtime [--json]

---

🌸 Release-related commands 🌸

• yarn version — apply a new version to the current package. Version bump, new era. 🎉

yarn version [-d,--deferred] [-i,--immediate] <strategy>

• yarn version apply — apply all the deferred version bumps at once. Apply all the bumps. 💥

yarn version apply [--all] [--dry-run] [--prerelease] [-R,--recursive] [--json]

• yarn version check — check that all the relevant packages have been bumped. Check those bumps. 🔍

yarn version check [-i,--interactive]

---

🌸 Workspace-related commands 🌸

• yarn workspace — run a command within the specified workspace. Workspace-specific command. 🏢

yarn workspace <workspaceName> <commandName> ...

• yarn workspaces focus — install a single workspace and its dependencies. Focus on one. 🎯

yarn workspaces focus [--json] [--production] [-A,--all] ...

• yarn workspaces foreach — run a command on all workspaces. For each workspace, do the thing. 🔁

yarn workspaces foreach [--from #0] [-A,--all] [-R,--recursive] [-W,--worktree] [-v,--verbose] [-p,--parallel] [-i,--interlaced] [-j,--jobs #0] [-t,--topological] [--topological-dev] [--include #0] [--exclude #0] [--no-private] [--since] [-n,--dry-run] <commandName> ...

• yarn workspaces list — list all available workspaces. List the workspaces. 📋

yarn workspaces list [--since] [-R,--recursive] [--no-private] [-v,--verbose] [--json]

---

You can also print more details about any of these commands by calling them with the -h,--help flag right after the command name. That's the cheat code, bestie. 💅

---

Anyway, this whole page is brought to you by yarnpkg 4.0.1, dated October 2023, and it's serving YARN(1) realness. Bye bestie, go install something iconic. 💖✨