npm install
npm installは、パッケージをインストールするコマンドです。
エイリアスi、isntall、add
解説
パッケージはnpmのリポジトリから自動でダウンロードしてインストールされます。
リポジトリに登録されているパッケージは以下サイトで公開されています。
→ https://www.npmjs.com/(npm公式サイト)
インストール先はグローバルとローカルがあり、デフォルトではローカルにインストールされます。
グローバルにインストールしたい場合は -gオプションを指定してください。
インストールした情報はpackage.jsonファイルに記載されます。
記載欄にはdependencies欄とdevDependencies欄の2つがあり、
デフォルトではdependencies欄に記載されます。
devDependencies欄に記載したい場合は -Dオプションを指定してください。
dependencies欄とdevDependencies欄の違いについては、下記備考欄をご覧ください。
パッケージ名の後ろに@で区切ってインストールするバージョンを指定することもできます。
また、半角スペースで区切って複数のパッケージ名を指定することも可能です。
構文
- (構文)パッケージを指定してインストールする
- npm install [オプション] <パッケージ名>[@バージョン] npm i [オプション] <パッケージ名>[@バージョン] npm isntall [オプション] <パッケージ名>[@バージョン] npm add [オプション] <パッケージ名>[@バージョン]
- (構文)package.jsonの設定に従いインストールする
- npm install [オプション] npm i [オプション] npm isntall [オプション] npm add [オプション]
install、i、isntall、add どれを使用しても実行結果は同じです。
オプション | 説明 |
---|---|
-D --save-dev | パッケージのインストール情報をpackage.jsonの devDependencies欄に追記する |
-S --save | パッケージのインストールした情報をpackage.jsonの dependencies欄に追記する ※npm 5.0.0以降ではデフォルトで追記されるため指定不要 (npm5以降のデフォルト) |
--no--save | パッケージのインストール情報をpackage.jsonに書き込まない (npm4以前のデフォルト) |
-g --global | パッケージをグローバルにインストールする |
--production | package.jsonのdependencies欄に含まれるパッケージのみインストールする ※パッケージの指定は不可 |
--save-exact | キャレット無しでpackage.jsonにバージョン番号を書き込む ※固定バージョンになります |
-h | コマンドのヘルプを表示する |
サンプル
パッケージ「react」をローカルにインストールする
C:\myapp>npm install react
パッケージ「react」と「typescript」をローカルにインストールする
C:\myapp>npm install react typescript
パッケージ名を半角スペースで区切って指定します
パッケージ「typescript」をグローバルにインストールする
C:\myapp>npm install -g typescript
パッケージ「webpack」をインストールし、package.jsonのdevDependencies欄に追記する
C:\myapp>npm install -D webpack
devDependencies欄は開発にのみ必要なパッケージを記載する欄です
バージョン3.2.1のパッケージ「typescript」をインストールする
C:\myapp>npm install typescript@3.2.1
package.jsonの設定に従いインストールする
C:\myapp>npm install
カレントフォルダにpackage.jsonが存在する必要があります
package.jsonの設定に従いインストールする(dependencies欄に記載されたパッケージのみ)
C:\myapp>npm install –production
カレントフォルダにpackage.jsonが存在する必要があります
npm installコマンドのヘルプを表示する
C:\>npm install -h
備考
- npm install、npm i どちらも実行結果は同じです。
(npm iは npm installのエイリアスです。) - インストールするとインストール情報がpackage.jsonに追記されます。
追記場所はdependencies欄とdevDependencies欄があり、以下の違いがあります。
dependencies欄:本番環境で必要なパッケージ一覧
devDependencies欄:開発環境で必要なパッケージ一覧
関連項目
- npm init:package.jsonファイルを作成する
- npm update:パッケージを更新する
- npm outdated:アップデートが可能なパッケージの一覧を確認する
- npm uninstall:パッケージをアンインストールする