pnpm add <pkg>
パッケージとそれが依存しているすべてのパッケージをインストールします。 デフォルトでは、すべての新しいパッケージは production 依存として追加されます。
概要
コマンド | 意味 |
---|---|
pnpm add sax | dependencies へ保存 |
pnpm add -D sax | devDependencies へ保存 |
pnpm add -O sax | optionalDependencies へ保存 |
pnpm add -g sax | グローバルにインストール |
pnpm add sax@next | next タグに対応するバージョンを保存 |
pnpm add sax@3.0.0 | バージョン 3.0.0 を指定 |
サポートされているパッケージの取得先
npm レジストリからインストール
pnpm add package-name
はデフォルトでは、最新のバージョンの package-name
を npm registry より追加します。
ワークスペースで実行された場合、最初に他のプロジェクトが指定された依存パッケージを使用しているかどうかを確認しようとします。 その場合、すでに使用されているバージョン範囲がインストールされます。
また、次のようにパッケージをインストールすることも可能です。
- tag を指定:
pnpm add express@nightly
- バージョンを指定:
pnpm add express@1.0.0
- バージョン範囲を指定:
pnpm add express@2 react@">=0.1.0 <0.2.0"
Install from the JSR registry
Added in: v10.9.0
To install packages from the JSR registry, use the jsr:
protocol prefix:
pnpm add jsr:@hono/hono
pnpm add jsr:@hono/hono@4
pnpm add jsr:@hono/hono@latest
This works just like installing from npm, but tells pnpm to resolve the package through JSR instead.
ワークスペースからインストール
ワークスペース から依存を追加して作業する場合は、依存パッケージの取得先は、 link-workspace-packages
と workspace: プロトコルの範囲指定
の設定によって決定されます。
ローカルファイルシステムからインストール
ローカルファイルシステムからインストールする方法は2つあります。
- tarball ファイルから (
.tar
,.tar.gz
, or.tgz
) - ディレクトリから
例:
pnpm add ./package.tar.gz
pnpm add ./some-directory
ディレクトリからインストールする場合は、現在のプロジェクトの node_modules
にシンボリックリンクが作成されるため、pnpm link
を実行した場合と同様になります。
リモートの tarball からインストール
引数は、 "http://" または "https://" で始まるフェッチ可能な URL でなければなりません。
例:
pnpm add https://github.com/indexzero/forever/tarball/v0.5.6
Git リポジトリからインストール
pnpm add <git remote url>
ホストされた Git プロバイダからパッケージを Git でクローンしてインストールします。
Gitからパッケージをインストールするには、以下の方法があります。
- デフォルトブランチの最新コミット:
pnpm add kevva/is-positive
- Git コミットハッシュ:
pnpm add kevva/is-positive#97edff6f525f192a3f83cea1944765f769ae2678
- Git ブランチ:
pnpm add kevva/is-positive#master
- refs に対する相対的な Git ブランチ:
pnpm add zkochan/is-negative#heads/canary
- Git タグ:
pnpm add zkochan/is-negative#2.0.1
- v で始まる Git タグ:
pnpm add andreineculau/npm-publish-git#v0.0.7
semver を使用して Git リポジトリからインストールする
semver:
パラメータを使用すると、インストールするバージョン (範囲) を指定できます。 例:
- 厳密な semver:
pnpm add zkochan/is-negative#semver:1.0.0
- v で始まる厳密な semver:
pnpm add andreineculau/npm-publish-git#semver:v0.0.7
- semver バージョン範囲:
pnpm add kevva/is-positive#semver:^2.0.0
- v で始まる semver バージョン範囲:
pnpm add andreineculau/npm-publish-git#semver:<=v0.0.7
Git リポジトリのサブディレクトリからインストールする
path:
パラメータを使用すると、Git でホストされているモノレポからサブディレクトリのみをインストールすることもできます。 例:
pnpm add RexSkz/test-git-subfolder-fetch#path:/packages/simple-react-app
完全な URL 経由で Git リポジトリからインストールする
もっと明確にしたい場合や、別の Git ホスティングを使用している場合は、完全な Git URL を明記することをおすすめします。
# git+ssh
pnpm add git+ssh://git@github.com:zkochan/is-negative.git#2.0.1
# https
pnpm add https://github.com/zkochan/is-negative.git#2.0.1
ホスティングプロバイダーのショートカットを使用して、Git リポジトリからインストールする
特定の Git プロバイダーには、プロトコルの省略形 [provider]:
が使用できます。
pnpm add github:zkochan/is-negative
pnpm add bitbucket:pnpmjs/git-resolver
pnpm add gitlab:pnpm/git-resolver
[provider]:
が省略された場合、デフォルトで github:
になります。
さまざまなパラメータを組み合わせて Git リポジトリからインストールする
&
で区切ることで、複数のパラメータを組み合わせることができます。 これはモノレポのフォークで便利です:
pnpm add RexSkz/test-git-subdir-fetch.git#beta\&path:/packages/simple-react-app
このコマンドは、beta
ブランチの /packages/simple-react-app
のサブディレクトリのみをインストールします。
オプション
--save-prod, -P
指定されたパッケージを通常の dependencies
としてインストールします。
--save-dev, -D
指定されたパッケージを通常の devDependencies
としてインストールします。
--save-optional, -O
指定されたパッケージを通常の optionalDependencies
としてインストールします。
--save-exact, -E
pnpm のデフォルトの semver 範囲指定演算子を使用するのではなく、固定したバージョンで保存します。
--save-peer
--save-peer
を使うことで、1つ以上の依存パッケージを peerDependencies
と devDependencies
の両方に追加します。
--save-catalog
Added in: v10.12.1
Save the new dependency to the default catalog.
--save-catalog-name <catalog_name>
Added in: v10.12.1
Save the new dependency to the specified catalog.
--config
Added in: v10.8.0
Save the dependency to configDependencies.
--ignore-workspace-root-check
--ignore-workspace-root-check
または -w
フラグが使用されていない限り、新しい依存関係をワークスペースのルートに追加しようとすると失敗します。
例: pnpm add debug -w
--global, -g
パッケージをグローバルにインストールします。
--workspace
ワークスペースで見つかった場合にのみ、新しい依存関係を追加します。
--allow-build
追加されたバージョン:v10.4.0
インストール中に postinstall スクリプトを実行することを許可するパッケージのリスト。
例:
pnpm --allow-build=esbuild add my-bundler
This will run esbuild
's postinstall script and also add it to the onlyBuiltDependencies
field of pnpm-workspace.yaml
. したがって、esbuild
は今後も常にスクリプトの実行を許可されるようになります。
--filter <package_selector>
詳細についてはフィルタリングに関するドキュメントを参照してください。
--cpu=<name>
Added in: v10.14.0
Override CPU architecture of native modules to install. Acceptable values are same as cpu
field of package.json
, which comes from process.arch
.
--os=<name>
Added in: v10.14.0
Override OS of native modules to install. Acceptable values are same as os
field of package.json
, which comes from process.platform
.
--libc=<name>
Added in: v10.14.0
Override libc of native modules to install. Acceptable values are same as libc
field of package.json
.