npmコマンド チートシート

プロジェクトを開始し、package.json ファイルを管理するためのコマンドです。

使用例:

# 対話形式で package.json を作成
npm init
# デフォルト値で package.json を作成
npm init -y
# scripts に "start" スクリプトを追加
npm set-script start "node server.js"
# package.json のバージョンを取得
npm pkg get version
# package.json にカスタムフィールドを追加
npm pkg set customField.enabled=true

プロジェクトに必要なパッケージをインストールするためのコマンドです。

使用例:

# プロジェクトの依存関係を全てインストール
npm install
# React を dependencies にインストール
npm install react
# Jest を devDependencies にインストール (-D は --save-dev のエイリアス)
npm install jest -D
# 特定バージョンの Lodash をインストール
npm install lodash@4.17.20
# バージョンを固定して Express をインストール (-E は --save-exact のエイリアス)
npm install express -E
# グローバルに http-server をインストール (-g は --global のエイリアス)
npm install -g http-server
# package-lock.json に基づいてクリーンインストール (CI環境向け)
npm ci
# 本番用の依存関係のみインストール
npm install --production
# Gitリポジトリからインストール
npm install git+ssh://git@github.com:lodash/lodash.git#4.17.21

インストール済みのパッケージを最新版に更新したり、不要になったパッケージを削除したりするためのコマンドです。

使用例:

# ローカルパッケージを可能な限り更新
npm update
# 特定のパッケージ 'lodash' を更新
npm update lodash
# グローバルパッケージを可能な限り更新
npm update -g
# ローカルから 'axios' をアンインストールし、package.json も更新
npm uninstall axios
# グローバルから 'create-react-app' をアンインストール
npm uninstall -g create-react-app
# package.json に記載されていないパッケージを node_modules から削除
npm prune

インストールされているパッケージを確認したり、npm レジストリ上のパッケージを検索したりするためのコマンドです。

使用例:

# ローカルパッケージをツリー表示
npm list
# ローカルのトップレベルパッケージのみ表示
npm list --depth=0
# グローバルのトップレベルパッケージのみ表示
npm list -g --depth=0
# 更新可能なローカルパッケージを表示
npm outdated
# 'react' というキーワードでパッケージを検索
npm search react
# 'react' パッケージの利用可能な全バージョンを表示
npm view react versions
# 'lodash' パッケージの最新バージョン情報を表示
npm view lodash version
# 重複している依存関係を探す
npm find-dupes

package.json の scripts セクションに定義されたコマンドを実行します。

package.json の例:

{ "name": "my-app", "version": "1.0.0", "scripts": { "start": "node index.js", "dev": "nodemon index.js", "test": "jest", "lint": "eslint .", "build": "webpack --mode production" }, "dependencies": { ... }, "devDependencies": { ... }
}

使用例:

# start スクリプトを実行 (node index.js が実行される)
npm start
# dev スクリプトを実行 (nodemon index.js が実行される)
npm run dev
# test スクリプトを実行 (jest が実行される)
npm test
# lint スクリプトを実行
npm run lint
# test スクリプトに引数 --coverage を渡して実行
npm run test -- --coverage
# 利用可能なスクリプト一覧を表示
npm run
# ローカルにインストールされた webpack を使ってビルド
npx webpack --mode development

作成したパッケージを npm レジストリに公開するためのコマンドです。公開前に npm アカウントでのログインが必要です。

使用例:

# npm にログイン
npm login
# 現在のログインユーザーを確認
npm whoami
# パッチバージョンを上げて Git タグも作成
npm version patch
# マイナーバージョンを上げる (Git タグなし)
npm version minor --no-git-tag-version
# パッケージを公開 (スコープなしの場合)
npm publish
# スコープ付きパッケージを公開 (例: @my-org/my-package)
# package.json の name が "@my-org/my-package" である必要あり
npm publish --access public
# 'beta' タグを付けて公開
npm publish --tag beta
# 特定バージョンを非推奨にする
npm deprecate my-package@"< 1.0.0" "このバージョンは古いので使用しないでください。1.0.0 以上を利用してください。"
# パッケージ 'my-package' にユーザー ' collaborator' をメンテナーとして追加
npm owner add collaborator my-package

npm の動作を設定したり、キャッシュを管理したりするためのコマンドです。

使用例:

# レジストリをプライベートレジストリに設定 (ユーザーレベル)
npm config set registry https://my-private-registry.example.com
# 設定されたレジストリを確認
npm config get registry
# init コマンドのデフォルト作者名を設定
npm config set init-author-name "My Name"
# 全ての設定を表示
npm config list -l
# npm キャッシュを検証・クリーンアップ
npm cache verify
# グローバルインストール先のパスを表示
npm get prefix -g
# キャッシュディレクトリのパスを表示
npm get cache

npm のバージョン確認やヘルプ表示など、その他の便利なコマンドです。

使用例:

# npm のバージョンを表示
npm -v
# npm install コマンドのヘルプを表示
npm help install
# npm 環境の診断を実行
npm doctor
# 現在のプロジェクトのリポジトリをブラウザで開く
npm repo
# 'react' パッケージのバグトラッカーをブラウザで開く
npm bugs react
# ローカルの node_modules ディレクトリのパスを表示
npm root