node.jsパッケージ管理ツールnpmの使い方

npmコマンドでnode.jsのモジュールを管理できます。

1 概要
2 npm自体のインストール
3 npm コマンドラインオプション
4 ヘルプを表示する
5 npmのバージョンを確認する
6 モジュールのインストール
7 パッケージをグローバルにインストールする
8 パッケージのバージョンを指定してインストールする
9 モジュールのアンインストール
10 モジュールのアップデート
11 モジュールのリスト
12 モジュールの情報を表示する
13 npmリポジトリを検索する
14 関連項目

概要

npmコマンドでnode.jsのモジュールを管理します。

npm自体のインストール

npmコマンドのインストールは、node.jsのインストールをご参照ください。

npm コマンドラインオプション

Usage: npm <command>
 
where <command> is one of:
    add-user, adduser, apihelp, author, bin, bugs, c, cache,
    completion, config, ddp, dedupe, deprecate, docs, edit,
    explore, faq, find, find-dupes, get, help, help-search,
    home, i, info, init, install, isntall, issues, la, link,
    list, ll, ln, login, ls, outdated, owner, pack, prefix,
    prune, publish, r, rb, rebuild, remove, repo, restart, rm,
    root, run-script, s, se, search, set, show, shrinkwrap,
    star, stars, start, stop, submodule, tag, test, tst, un,
    uninstall, unlink, unpublish, unstar, up, update, v,
    version, view, whoami
 
npm <cmd> -h     quick help on <cmd>
npm -l           display full usage info
npm faq          commonly asked questions
npm help <term>  search for help on <term>
npm help npm     involved overview
 
Specify configs in the ini-formatted file:
    /home/kaworu/.npmrc
or on the command line via: npm <command> --key value
Config info can be viewed via: npm help config
 
npm@1.3.11 /usr/local/lib/node_modules/npm

ヘルプを表示する

$ npm help
$ npm help install
$ npm help install -l

npmのバージョンを確認する

$ npm --version
1.4.6
$ npm -v
1.4.6
$ npm version
{ http_parser: '1.0',
  node: '0.10.31',
  v8: '3.14.5.9',
  ares: '1.9.0-DEV',
  uv: '0.10.28',
  zlib: '1.2.8',
  modules: '11',
  openssl: '1.0.1i',
  npm: '1.4.6' }

モジュールのインストール

$ npm install モジュール名

$ npm install forever
npm http GET https://registry.npmjs.org/forever
npm http 200 https://registry.npmjs.org/forever
npm http GET https://registry.npmjs.org/forever/-/forever-0.10.11.tgz
npm http 200 https://registry.npmjs.org/forever/-/forever-0.10.11.tgz
 
... 省略
 
forever@0.10.11 node_modules/forever
├── watch@0.8.0
├── colors@0.6.2
├── pkginfo@0.3.0
├── timespan@2.3.0
├── utile@0.2.1 (deep-equal@0.2.1, rimraf@2.2.6, ...省略)
├── nssocket@0.5.1 (eventemitter2@0.4.13, lazy@1.0.11)
├── optimist@0.6.1 (wordwrap@0.0.2, minimist@0.0.8)
├── nconf@0.6.9 (ini@1.1.0, async@0.2.9, optimist@0.6.0)
├── cliff@0.1.8 (eyes@0.1.8, winston@0.6.2)
├── winston@0.7.3 (cycle@1.0.3, stack-trace@0.0.9, ...省略)
├── forever-monitor@1.2.3 (watch@0.5.1, minimatch@0.2.14, ...省略)
└── flatiron@0.3.11 (director@1.1.10, optimist@0.6.0, ...省略)

パッケージをグローバルにインストールする

npm install パッケージだと、ローカルディレクトリにインストールされます。システムワイドにインストールする場合には、-g オプションを使用します。

$ sudo npm install -g パッケージ
$ sudo npm install -g パッケージ1 パッケージ2 パッケージ3

パッケージのバージョンを指定してインストールする

$ sudo npm install -g パッケージ名@1.2.3

モジュールのアンインストール

ローカルディレクトリから削除します。

$ npm uninstall モジュール名

グローバルから削除するには、以下の通りです。

$ npm uninstall -g モジュール名

モジュールのアップデート

$ npm update

モジュールのリスト

インストールしたモジュールは、listオプションで表示できます。空っぽの場合は、以下の通りです。

$ npm list
/tmp
└── (empty)

$ npm list
/tmp
└─┬ forever@0.10.11
  ├─┬ cliff@0.1.8
  │ ├── eyes@0.1.8
  │ └─┬ winston@0.6.2
  │   ├── async@0.1.22
  │   ├── cycle@1.0.3
  │   ├── pkginfo@0.2.3
  │   ├── request@2.9.203
  │   └── stack-trace@0.0.9
  ├── colors@0.6.2
省略

グローバルにインストールされたパッケージを確認するには、-gをつけます。

$ sudo npm list -g

個別のパッケージを指定することもできます。

$ sudo npm list -g パッケージ名

モジュールの情報を表示する

$ npm info forever
 
{ name: 'forever',
  description: 'A simple CLI tool for ensuring that a given node script runs continuously (i.e. forever)',
  'dist-tags': { latest: '0.10.11' },
  versions:
   [ '0.6.0',
     '0.6.1',
     '0.6.2',
 
省略

npmリポジトリを検索する

$ npm search キーワード