npmでよく使うコマンドまとめ

2020-02-242021-05-07

URLをコピーしました！

npmのコマンドいつも忘れちゃう
ふとした時にやりたいことが思い出せない
そんな人に向けたメモ

環境構築をする上で便利なパッケージ管理にnpmがあります。

npmでは使用するパッケージを簡単にインストールしたり、package.jsonに記載しているパッケージを一括でインストールしたり、開発環境を構築する上でとっても便利です。

起動時やビルドするときにもnpmスクリプトを使って実行するのでみなさん当たり前のように使っていると思います。

今回はnpmでよく使うコマンドをまとめておきたいと思います。

毎回Google先生でコマンドを調べてたりしてたので、いつでも見れるようにしておきます。

npmのコマンドを調べている人の少しでも参考になればうれしいです。

この記事でわかること

npmのよく使うコマンド・使い方

セットアップコマンド

npmのインストール

npmを使用するためにNode.jsをインストールする必要があるので、Nodeのインストール方法は前に書いた記事を見てもらえると嬉しいです。

npm環境セットアップ(npm init)

npm環境をセットアップして、package.jsonを生成します。

$ npm init

npmのバージョン確認コマンド(npm -v)

$ npm -v

パッケージのインストールコマンド

プロジェクトにインストール(npm install)

$ npm install [パッケージ名]

ちなみに、installコマンドは以下のように省略可能です。

$ npm i [パッケージ名]

package.jsonに追加してインストール

package.jsonに自動で追加する場合は–saveまたは–save-devオプションを使用します。

$ npm install --save [パッケージ名]
または
$ npm install --save-dev [パッケージ名]

これでpackage.jsonのdependenciesかdevDependenciesに自動て書き込みを行ってくれます。

プロジェクトからアンインストール (npm uninstall)

$ npm uninstall [パッケージ名]

uninstallコマンドも省略や以下のコマンドでも同様にアンインストールが行えます。

$ npm un [パッケージ名] 
$ npm remove [パッケージ名] 
$ npm r [パッケージ名] 
$ npm rm [パッケージ名]

package.jsonからも削除してアンインストール

インストール同様に –saveまたは–save-davのオプションを付けます。

$ npm uninstall --save [パッケージ名]
または
$ npm uninstall --save-dev [パッケージ名]

グローバル環境にインストール・アンインストール

バージョンに関係なく、どのプロジェクトでも使用するようなパッケージをグローバル環境にインストールできます。

使用するにはinstallコマンド、uninstallコマンドに-gのオプションを付けて実行します。

$ npm install -g [パッケージ名]

パッケージをまとめてインストール(npm install|update)

package.jsonに記載されているパッケージをまとめてインストールします。

$ npm install
または
$ npm update

確認コマンド

インストールされているパッケージの確認(npm ls)

インストール済みのパッケージの一覧を表示するには以下のコマンドを使用します。

依存関係を含めないインストール済みのパッケージの確認

$ npm ls --depth=0

依存関係を含めたインストール済みのパッケージの確認

$ npm ls

こちらも同様に-gオプションを使用するとグローバル環境のパッケージの確認が行えます。