Skip to content

DNET_NpmCommands

Jump to bottom
nishi_74322014 edited this page Sep 11, 2026 · 1 revision

npmのコマンド

概要

npmのコマンド

詳細

インストール

  • package.json（npmの該当節を参照）の内容に従って、パッケージをインストール

    npm install
npm i

  • 個別にパッケージをインストール

    npm install [package-name]@[version]
npm i [package-name]@[version]

--globalオプション

  • グローバル・インストール（全てのプロジェクトで使える）

    npm install --global [package-name]@[version]
npm i -g パッケージ名

--saveオプション

パッケージをインストールし、その内容を package.json に保存する。

npm install --save
npm i -S

※ package.jsonが既存でないと保存しない。
　package.jsonが既存でない場合、npm init（npmの該当節を参照）しておく。

--save-devオプション

「開発ツール」としてインストール対象のライブラリを認識する。

npm install --save-dev webpack webpack-cli
npm i -D webpack webpack-cli

※ 自動で package.jsonの dependencies ではなく devDependencies に追記される。
　npm install --productionとすると、devDependenciesはインストールされない。

アンインストール

パッケージ（アンインストール）

npm uninstall パッケージ名
npm un パッケージ名

グローバル・パッケージ（アンインストール）

npm uninstall --global パッケージ名
npm un -g パッケージ名

アップデート

パッケージのアップデート
未インストールのパッケージはインストールしない

パッケージ（アップデート）

npm update
npm up
npm update パッケージ名
npm up パッケージ名

グローバル・パッケージ（アップデート）

npm update --global
npm up -g
npm update --global パッケージ名
npm up -g パッケージ名

インストール・パッケージの一覧表示

パッケージ（一覧表示）

npm list
npm ls

グローバル・パッケージ（一覧表示）

npm list --global
npm ls -g

セキュリティ監査

npm v6から「npm i」した際に、
以下のようなメッセージが表示される。

audited n packages in n.ns
found n vulnerabilities (n low, n high)
 run `npm audit fix` to fix them, or `npm audit` for details

監査レポートを取得

JSON形式の詳細な監査レポートを取得

npm audit

監査によりファイルを修正

package.json と package-lock.jsonが対象（オプションによるらしい）

npm audit fix

npm-scriptsタスクの実行

概要（npm-scripts）

  • npm run-script <スクリプト名> でスクリプトを実行可能。
  • スクリプトは、 package.json の scripts プロパティで定義する。
  • エイリアスがあるので、npm run <スクリプト名> でも実行可能。

testとstart

  • run サブコマンドの指定が不要。
  • test は t および tst というエイリアスを持っている

preとpost

  • pre-testとpost-testなどを定義する。
  • コマンドの前後に処理を挿入できる。

便利タスク

あると便利なタスクの定義

スクリプト名 目的
build ビルド
clean ビルド結果の削除
type-check 型チェック
lint 静的コード解析
coverage コードカバレッジ計測

npx

  • コマンドやスクリプトを実行するユーティリティ。

  • インストール

    • インストールする場合はnpm install -g npxを実行する。
    • npmのバージョン5.2.0以降はnpxがプリインストールされている

透過的に実行

ローカルにインストールしたnpm packageのコマンドを透過的に実行する。

  • npmの場合

  • npxの場合

    > npx パッケージ名

一時的に実行

ローカルに存在しないコマンドでも一時的にダウンロードして実行する

  • グローバルインストールしないで一度だけコマンドを実行

    >npx cowsay hoge
npx: installed 10 in 4.403s
 ______
< hoge >
 ------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

  • GitHubやGistで公開されているものを実行

    > npx github:ユーザー名/リポジトリ名

バージョンを指定して実行

nodeのバージョンを指定してnpm-scriptsを実行できる

> npx -p node@10.3.0 npm run build

参考

npx（参考）

Qiita

zenn.dev

移行メモ

  • 「npx githhub:ユーザー名/リポジトリ名」は「github:」の誤記のため修正した。 また「GitHubやGistで公開されている実行」は文が欠けていたため 「〜公開されているものを実行」とした。
  • 同名の見出し（「パッケージ」「グローバル・パッケージ」「npx」「概要」）が 複数あり GitHub Wiki でアンカが衝突するため、括弧で文脈を補って一意にした。
  • PukiWiki のページ内アンカ（#xxxxxxxx）は GitHub Wiki では再現できないため、 同一ページ内のアンカは見出しから生成されるアンカに張り替え、 他ページのアンカを指すリンクは「〜（ページ名 の該当節を参照）」の形に置き換えた。

Tags: 移行, npm, npx, Node.js, パッケージ管理, npm-scripts, セキュリティ監査

このWikiは「Open棟梁Project」,「OSSコンソーシアム 開発基盤部会」によって運営されています。

NetDevInfraWiki

マイクロソフト系技術情報 Wiki
Open 棟梁 Wiki

（未着手）

開発基盤部会 Wiki

移行管理: DONE ／ TODO

Clone this wiki locally