npmのコマンドまとめ|パッケージのインストール・削除・確認など【Node.js】

npm(Node Packaged Modules)は、Node.jsのパッケージ(モジュール)の管理などができるツールとなり、Node.jsと一緒にインストールされます。

npmでは、パッケージをグローバルにインストールして利用する方法と、プロジェクト毎のローカルにインストールして利用する方法がありますが、今回は、主にnpmをローカルで利用する際のコマンドまとめとなります。

また、Node.jsのインストールについては、以下のリンク先を参考にしてみてください。

npm自体に関連するコマンド

以下、npm自体に関連するコマンドとなります。

バージョンを確認

npm -v

最新バージョンにする

npm update npm

ヘルプを確認

npm help

npmの問題をチェック

npm doctor

プロジェクトでnpmを利用する準備

プロジェクトでnpmを利用するには、まず、インストールしたパッケージの情報などが記載されるpackage.jsonを、プロジェクト内のディレクトリに配置します。

また、既存のpackage.jsonを利用することで、プロジェクトで利用するパッケージのセットアップを簡単に行うこともできます。

package.jsonを作成

新規package.jsonを作成するには、まず、プロジェクト内でnpmを配置するディレクトリ(npmのルート)にcdコマンドで移動します。

そして、package.jsonを作成する以下のコマンドを入力します。

npm init

上記コマンドを入力すると、package.json内に記述する項目の入力を求められますが、「Enter」を押してスキップしpackage.jsonを作成しても大丈夫です。

また、項目の入力を省略してpackage.jsonを作成する場合は、以下の-yオプションを指定したコマンドとなります。

npm init -y

パッケージに関連するコマンド

以下、package.jsonファイルのあるディレクトリで利用する、パッケージに関するコマンドとなります。

指定したパッケージをインストール

パッケージをインストール(dependenciesに記載)

プロジェクトで利用するパッケージをインストールする場合は、以下のコマンドとなります。

また、以下のコマンドでパッケージをインストールすると、package.json内のdependenciesの箇所にパッケージ名が記載されます。

npm install パッケージ名

また、コマンドのinstallは以下のようにiでも可能。

npm i パッケージ名

なお、パッケージ名を複数指定することもできます。

開発環境でのみ利用するパッケージをインストール(devDependenciesに記載)

プロジェクトの開発環境のみで利用するパッケージをインストールする場合は、以下の--save-devオプションを指定したコマンドを使用します。

また、以下のコマンドでパッケージをインストールすると、package.json内のdevDependenciesの箇所にパッケージ名が記載されます。

npm install パッケージ名 --save-dev

また、オプションの--save-devは以下のように-Dでも可能。

npm install パッケージ名 -D

なお、パッケージ名を複数指定することもできます。

既存のpackage.jsonからパッケージをインストール

パッケージは、既存のpackage.jsonを元にインストールすることも可能です。

dependenciesとdevDependenciesのパッケージをインストール

package.json内のdependenciesとdevDependenciesに記載されているすべてのパッケージをインストールする場合は、以下のコマンドとなります。

npm install

dependenciesのパッケージのみをインストール

package.json内のdependenciesに記載されているパッケージのみをインストールする場合は、以下の--productionオプションを指定したコマンドとなります。

npm install --production

パッケージのアンイストール

 npm uninstall パッケージ名

また、コマンドのuninstallは以下のようにrmでも可能。

npm rm パッケージ名

なお、パッケージ名を複数指定することもできます。

インストール済みのパッケージを確認

インストール済みのパッケージの確認するコマンドは以下となります。

npm ls

上記コマンドでは、インストールしたパッケージが依存しているパッケージもツリー構造で出力されるため、多くのパッケージ名が出力されます。

そのため、明示的にインストールしたパッケージのみを確認するには、以下の--depth=0オプションを指定し、出力するツリー構造を最初の階層のみとします。

npm ls --depth=0

パッケージの脆弱性を確認・修正

パッケージの脆弱性を確認

npm audit

パッケージの脆弱性を修正

以下のコマンドでは、プロジェクトの脆弱性を確認し、更新プログラムを自動的にインストールします。

npm audit fix

また、上記コマンドでは修正できないこともあるようです。詳しくは以下のリンク先を参考にしてみてください。

脆弱性の警告を受けたnpmパッケージの依存関係を力技で直す - Qiita

古いバージョンのパッケージを確認

npm outdated

パッケージを更新

指定したパッケージを更新

npm update パッケージ名

なお、パッケージ名を複数指定することもできます。

すべてのパッケージを更新

npm update

依存しているパッケージの重複を整理

以下のコマンドでは、パッケージが依存しているパッケージの重複を整理して、パッケージの構造を単純化します。

npm dedupe

その他のコマンドについて

npmのその他のコマンドやオプションについては、以下のリンク先などを参考にしてみてください。

参考サイトなど

コメント投稿またはTwitterで返信

コメントは、以下の項目(*は必須項目)を入力し「コメントを送信」ボタンから送信お願いします。メールアドレスは公開されることはありません。
Twitterで返信する場合はこちらから。

また、コメントは承認制となります。