yarn

Yarn 1.x (classic) / Yarn 4 (berry)

日常的に使う Yarn CLI コマンド(Yarn Classic 1.x と Yarn Berry 2/3/4 両方)のクイックリファレンス:install / add / remove / run / workspaces、ロックファイル、Plug'n'Play、Berry 構成 — よく使うオプションと実用例をまとめました。

33 コマンド

インストール (Classic 1.x)

yarn install

`package.json` にリストされたすべての依存関係をインストールし、`node_modules` と `yarn.lock` を作成または更新します。

--frozen-lockfile ロックが変更される場合は失敗 (CI); --production / --prod devDeps をスキップ; --no-progress; --silent

yarn install --frozen-lockfile

`yarn.lock` が `package.json` と完全一致する場合のみインストールします。CI で再現可能なビルドを保証するために使用されます。

yarn install --frozen-lockfile

インストール (Berry)

yarn install

Berry 既定:`.yarnrc.yml` で `nodeLinker: pnp` の場合 Plug'n'Play を使用し、そうでない場合は `node_modules` にフォールバックします。`.yarn/cache` にキャッシュします。

--immutable ロックファイルのドリフトで失敗 (--frozen-lockfile の Berry 等価); --inline-builds; --mode=update-lockfile

yarn install --immutable

yarn set version <version>

プロジェクト内の Yarn バイナリを切り替えます。一般的なもの: `yarn set version stable`、`yarn set version 4.0.2`、`yarn set version classic`。

yarn set version stable

依存関係の追加

yarn add <pkg>

ランタイム依存関係を追加し、`package.json` + ロックファイルに書き込みます。Classic は `dependencies` に書き込み、Berry も同様です。

<pkg>@<version|range>; --dev / -D; --exact / -E; --optional / -O; --peer

yarn add lodash && yarn add -D typescript@^5 vitest

yarn add -D <pkg>

`devDependencies` に追加します。

yarn add -D typescript @types/node eslint

yarn add <pkg>@<version>

特定のバージョン、dist-tag(`@latest`、`@next`、`@canary`)、または git URL をインストールします。

yarn add [email protected] && yarn add next@latest

yarn global add <pkg>

ツールをグローバルにインストールします(Classic 1.x)。Berry はワンショットバイナリに `yarn dlx` を使用し、グローバルツールには `corepack` を推奨します。

yarn global add typescript

削除

yarn remove <pkg>

パッケージを `node_modules` と関連する `dependencies` / `devDependencies` セクションから削除します。

yarn remove lodash && yarn remove -D @types/node

更新

yarn upgrade

現在の semver 範囲内ですべての依存関係をアップグレードします。`yarn upgrade --latest` は利用可能な最新リリースへジャンプし範囲を書き換えます。

--latest; --pattern <glob>; --caret; --exact; -i / --interactive

yarn upgrade && yarn upgrade eslint --latest

yarn upgrade <pkg>@<version>

1 つのパッケージを特定のバージョンにアップグレードします。

yarn upgrade [email protected]

スクリプト実行

yarn run <script>

`package.json` からスクリプトを実行します。`yarn test`、`yarn start`、`yarn build` は短縮形です。

-- <args> 引数をスクリプトに転送

yarn run build -- --mode production

yarn <script>

`yarn run <script>` と同じ — `run` キーワードなしで定義済みのスクリプトを名前で呼び出します。

yarn test && yarn lint:fix

yarn dlx <pkg> [args]

ローカルにインストールせずにオンデマンドでパッケージバイナリを実行します(`npx` の Berry 等価)。`~/.yarn/berry/cache` にキャッシュします。

-p / --package パッケージを選択; -q / --quiet

yarn dlx create-vite my-app --template vue

ワークスペース

yarn workspaces add <pkg>

monorepo ワークスペースのルートに依存関係を追加します(1.x)。

yarn workspaces add typescript -D

yarn workspace <ws> add <pkg>

monorepo 内の指定された単一のワークスペースに依存関係を追加します。

yarn workspace @myorg/web add react && yarn workspace @myorg/api add -D vitest

yarn workspaces run <script>

すべてのワークスペースでスクリプトを実行します。`yarn workspaces foreach run <script>`(Berry)は並列実行とトポロジー順序をサポートします。

--parallel; --topological; --continue; --interlaced

yarn workspaces foreach run build --topological --parallel

確認

yarn list

依存関係ツリーを出力します。`--pattern <regex>` でフィルタし、`--depth 0` で直接依存関係のみを表示します。

--depth=N; --pattern; --json

yarn list --depth=0 && yarn list --pattern "^react$"

yarn why <pkg>

特定のパッケージがなぜインストールされているかを説明します — 取り込んだ依存関係の連鎖です。

yarn why react && yarn why @types/node

yarn info <pkg>

パッケージのレジストリメタデータ(バージョン、依存関係、dist-tag、readme 抜粋)を出力します。おおよそ `npm view` と同等です。

<pkg>@<version>; <pkg> readme; <pkg> dependencies

yarn info react dist-tags && yarn info lodash versions

yarn licenses list

依存関係ツリー全体のすべてのライセンス(SPDX 識別子 + 著者)を表示します。ライセンスコンプライアンスレビューに便利です。

yarn licenses list

Berry 構成

yarn config set <key> <value>

構成エントリを `.yarnrc.yml`(Berry)に書き込みます。一般的なキー: `nodeLinker`、`npmRegistryServer`、`enableTelemetry`、`yarnPath`。

yarn config set nodeLinker node-modules && yarn config set enableTelemetry false

yarn config get <key>

単一の構成エントリを読み取ります。

yarn config get nodeLinker

キャッシュ

yarn cache clean

Yarn キャッシュを消去します(Classic: `~/.yarn-cache`、Berry: `.yarn/cache`)。

yarn cache clean

yarn cache dir

キャッシュディレクトリパスを出力します。

yarn cache dir

ロックファイル

yarn import

Berry のみ — npm から `package-lock.json` を Yarn のロックファイル形式にインポートします。

yarn import

yarn constraints

Berry のみ — `constraints.pro` の Prolog で書かれたプロジェクト全体の依存関係ルールを強制します(例: すべてのワークスペースが同じ React バージョンに依存する必要がある)。

yarn constraints

監査

yarn npm audit

Berry — npm レジストリのアドバイザリフィードへのプロキシ。ロックファイルの脆弱性を報告します。

--severity info|low|moderate|high|critical; --json

yarn npm audit --severity high

その他

yarn version

現在の Yarn バージョンを出力します(Classic と Berry の両方で動作)。

yarn version

yarn init

`package.json` を対話的に作成するか、 `-y` で既定値を使用します。

-y 既定を承諾; -p / --private private としてマーク

yarn init -y

yarn pack

現在のパッケージを tarball にバンドルしますが、公開はしません — オフライン配布に便利です。

--filename; --pack-destination <dir>

yarn pack --filename my-pkg.tgz

Plug'n'Play (Berry)

yarn unplug <pkg>

PnP zip ストアから単一のパッケージを通常の `node_modules/<pkg>` に抽出して、旧来の方法で require できるようにします(互換性のないツールの回避策)。

yarn unplug react && yarn install

yarn rebuild

現在の Node ABI 用にネイティブアドオンを再コンパイルします。Berry は PnP 配下でネイティブ依存関係を持つパッケージにこれを必要とします。

yarn rebuild

商標と利用についての告知

本コマンドラインツール・チートシート集はオープンコミュニティの参考資料です。本書で言及するツールの名前、ロゴ、商標（Git™、Docker™、Kubernetes®、kubectl、PostgreSQL®、MySQL®、Redis™、MongoDB®、Linux™、PowerShell™、Vim™ など）はすべてそれぞれの権利者の財産であり、本書では識別および参照の目的のみに使用しています。

本チートシートの全内容は独立して作成された簡略化された自己完結型の参考資料であり、いかなる公式ドキュメントにも所属せず、承認されておらず、また引用されたものでもありません。コマンド一覧、オプションフラグの説明、コード例はすべて著者による独自の簡略化です。権威ある情報については、各ツールの公式ドキュメントを参照してください。

コマンドの構文およびオプションフラグはツールのバージョンによって異なる場合があります。表示されるバージョンタグは安定リリースを示しています。他のバージョンでは動作が異なる場合があります。本書は商標権者による推奨や選好を意味するものではありません。

商標権者または著作権者の方で、当サイトの一部内容について権利侵害の懸念がある場合は[email protected]までご連絡ください。有効な権利証明を受領次第、合理的な期間内に関連内容を修正または削除いたします。

当サイトの情報を利用したことで生じたいかなる直接的・間接的損害についても、当サイトは法的責任を負いません。

Yarn について

Yarn は 2016 年 10 月に Facebook(Meta)によって、npm のより高速で決定的な代替として、Google、Exponent、Tilde の貢献と共にリリースされました。オリジナルの 1.x 系は「Yarn Classic」と呼ばれ、メンテナンスモードになっています。アクティブな系は「Yarn Berry」(2020 年の 2.0、2021 年の 3.0、2022 年の 4.0、現在の 5.x)です。Yarn Berry には `yarn`(Node が組み込まれた単一の 4 MB バイナリ)、`yarn dlx`(npx の代替)、`yarn workspaces`、Plug'n'Play(`yarn install --immutable` + `.pnp.cjs`)が同梱されています — これは既定で `node_modules` をインストールせず、単一の zip ストアからパッケージを解決する議論を呼ぶ既定です。Berry は `yarnrc.yml` ファイルで構成されます(YAML、Classic の `yarnrc` ini とは異なります)。両系列は同じマシンに共存できます:`yarn set version classic` と `yarn set version berry` でバイナリを切り替えます。Yarn はインストール時の速度が npm より速く(並列 + キャッシュ)、monorepo ポリシー用の `workspaces` と `constraints` をサポートし、`yarn why` / `yarn licenses` 内省機能を内蔵しています。データは Meta に送信されません — Yarn は BSD-2-Clause の独立した OSS です。

チートシートバージョン 1.0.0