(转)npm 常用命令详解

2017-11-02

字数统计: 1.6k字 | 阅读时长: 7分

白树的这篇有关npm 命令参数的文章写的很详细，自己后续也可能会反复看，所以整理一下转载到自己博客，只为了方便学习，如需转载用作商业用途，请联系作者本人。
本文原始地址：【原】npm 常用命令详解 - 白树 - 博客园
本文在原文的基础上有所删减。

本文以Windows平台上做测试，以gulp为示例做教程

1、npm是什么

NPM的全称是Node Package Manager，是随同NodeJS一起安装的包管理和分发工具，它很方便让JavaScript开发者下载、安装、上传以及管理已经安装的包。

2、npm install 安装模块

基础语法

npm install (with no args, in package dir)
npm install [<@scope>/]<name>
npm install [<@scope>/]<name>@<tag>
npm install [<@scope>/]<name>@<version>
npm install [<@scope>/]<name>@<version range>
npm install <tarball file>
npm install <tarball url>
npm install <folder>
alias: npm i
common options: [-S|--save|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [--dry-run]

安装包，默认会安装最新的版本

1	npm install gulp

安装指定版本

1	npm install gulp@3.9.1

安装包并将信息保持到项目的package.json文件中

项目对模块的依赖可以使用下面的 3 种方法来表示（假设当前版本号是 1.1.0 ）：

兼容模块新发布的补丁版本：~1.1.0、1.1.x、1.1
兼容模块新发布的小版本、补丁版本：^1.1.0、1.x、1
兼容模块新发布的大版本、小版本、补丁版本：*、x

-S, --save 安装包信息将加入到dependencies（生产阶段的依赖）

npm install gulp --save 或 npm install gulp -S

package.json 文件的 dependencies 字段：

1
2
3

"dependencies": {
    "gulp": "^3.9.1"
}

-D, --save-dev 安装包信息将加入到devDependencies（开发阶段的依赖），所以开发阶段一般使用它

npm install gulp --save-dev 或 npm install gulp -D
package.json 文件的 devDependencies字段：

1
2
3

"devDependencies": {
    "gulp": "^3.9.1"
}

-O, --save-optional 安装包信息将加入到optionalDependencies（可选阶段的依赖）

npm install gulp --save-optional 或 npm install gulp -O
package.json 文件的optionalDependencies字段：

1
2
3

"optionalDependencies": {
    "gulp": "^3.9.1"
}

-E, --save-exact 精确安装指定模块版本

npm install gulp --save-exact 或 npm install gulp -E
输入命令npm install gulp -ES，留意package.json 文件的 dependencies 字段，以看出版本号中的^消失了

1
2
3

"dependencies": {
    "gulp": "3.9.1"
}

模块的依赖都被写入了package.json文件后，他人打开项目的根目录（项目开源、内部团队合作），使用npm install命令可以根据dependencies配置安装所有的依赖包

本地安装（local）
npm install gulp
全局安装（global）,使用 -g 或 –global
npm install gulp -g

3、npm uninstall 卸载模块

基础语法

1
2
3

npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional]
aliases: remove, rm, r, un, unlink

如卸载开发版本的模块

npm uninstall gulp --save-dev

4、npm update 更新模块

基础语法
npm update [-g] [<pkg>...]

5、npm outdated 检查模块是否已经过时

基础语法
npm outdated [[<@scope>/]<pkg> ...]
此命令会列出所有已经过时的包，可以及时进行包的更新

6、npm ls 查看安装的模块

基础语法

1
2
3

npm ls [[<@scope>/]<pkg> ...]
aliases: list, la, ll

查看全局安装的模块及依赖

npm ls -g

7、npm init

在项目中引导创建一个package.json文件
安装包的信息可保持到项目的package.json文件中，以便后续的其它的项目开发或者他人合作使用，也说package.json在项目中是必不可少的。

npm init [-f|--force|-y|--yes]

8、npm help 查看某条命令的详细帮助

基础语法
npm help <term> [<terms..>]

例如输入npm help install，系统在默认的浏览器或者默认的编辑器中打开本地nodejs安装包的文件/nodejs/node_modules/npm/html/doc/cli/npm-install.html

9、npm root 查看包的安装路径

输出 node_modules的路径
npm root [-g]

10、npm config 管理npm的配置路径

基础语法

npm config set <key> <value> [-g|--global]
npm config get <key>
npm config delete <key>
npm config list
npm config edit
npm get <key>
npm set <key> <value> [-g|--global]

对于config这块用得最多应该是设置代理，解决npm安装一些模块失败的问题

例如我在公司内网，因为公司的防火墙原因，无法完成任何模块的安装，这个时候设置代理可以解决
npm config set proxy=http://xxx.com:8080

又如国内的网络环境问题，某官方的IP可能被和谐了，幸好国内有好心人，搭建了镜像，此时我们简单设置镜像

npm config set registry="http://r.cnpmjs.org"

也可以临时配置，如安装淘宝镜像

npm install -g cnpm --registry=https://registry.npm.taobao.org

11、npm cache 管理模块的缓存

基础语法

npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache add <name>@<version>
npm cache ls [<path>]
npm cache clean [<path>]

最常用命令无非清除npm本地缓存

npm cache clean

12、npm start 启动模块

基础语法
npm start [-- <args>]
该命令写在package.json文件scripts的start字段中，可以自定义命令来配置一个服务器环境和安装一系列的必要程序，如

1
2
3

"scripts": {
    "start": "gulp -ws"
}

此时在cmd中输入npm start命令相当于执行gulpfile.js文件自定义的watch和server命令。

如果package.json文件没有设置start，则将直接启动node server.js

13、npm stop 停止模块

基础语法

npm stop [-- <args>]

14、npm restart 重新启动模块

基础语法

npm restart [-- <args>]

15、npm test 测试模块

基础语法

1 2	npm test [-- <args>] npm tst [-- <args>]

该命令写在package.json文件scripts的test字段中，可以自定义该命令来执行一些操作，如

1
2
3

"scripts": {
    "test": "gulp release"
},

此时在cmd中输入npm test命令相当于执行gulpfile.js文件自定义的release命令。

16、npm version 查看模块版本

基础语法

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
'npm [-v | --version]' to print npm version
'npm view <pkg> version' to view a package's published version
'npm ls' to inspect current package/dependency versions

查看模块的版本

npm version

17、npm package.json的语法

国内有好心人整理：《npm的package.json中文文档》