NPM 常用命令
https://www.npmjs.com/
一、包安装与管理命令 (最常用)
命令 | 缩写 | 说明 |
---|---|---|
npm install | npm i | 根据 package.json 安装所有依赖。 |
npm install <package_name> | npm i <package_name> | 安装最新版本的包,并添加到 dependencies 。 |
npm install <package_name>@<version> 例: npm i lodash@4.17.21 | npm i <package_name>@<version> | 安装指定版本的包 |
npm install <package_name> --save-dev | npm i <package_name> -D | 安装包并添加到 devDependencies |
npm install <package_name> --global | npm i <package_name> -g | 全局安装包 |
npm uninstall <package_name> | npm un <package_name> | 卸载包,并从 dependencies 或 devDependencies 中移除 |
npm update | npm up | 更新所有包到 package.json 允许的最新版本。 |
npm update <package_name> | npm up <package_name> | 更新指定的包。 |
npm outdated | - | 检查有哪些过时的包。 |
二、项目与脚本运行命令
命令 | 说明 |
---|---|
npm init | 交互式地创建一个新的 package.json 文件。 |
npm init -y | 快速创建一份默认的 package.json (跳过提问)。 |
npm run <script_name> | 运行 package.json 中 scripts 对象定义的脚本。 |
npm run | 列出所有可运行的脚本命令。 |
npm start | 等同于 npm run start ,是一个常用默认脚本。 |
npm test | 等同于 npm run test ,用于运行测试。 |
npm restart | 先执行 stop ,再执行 start 。 |
npm stop | 停止一个脚本。 |
npm exec <command> | 在不永久安装的情况下,运行本地安装的包提供的命令。 |
三、信息查看与诊断命令
命令 | 说明 | |
---|---|---|
npm list | npm ls | 列出当前项目安装的所有包(树状结构)。 |
npm list --depth=0 | npm ls --depth=0 | 只列出顶层的直接依赖,更简洁。 |
npm list -g --depth=0 | 列出全局安装的顶级包。 | |
npm view <package_name> | npm v <package_name> | 查看包的注册表信息(版本、依赖、描述等)。 |
npm info <package_name> | 类似于 npm view ,显示包的详细信息。 | |
npm search <keyword> | 在 npm 仓库中搜索包含关键字的包。 | |
npm bin | 显示当前项目的 node_modules/.bin 目录路径。 | |
npm root | 显示当前项目的 node_modules 目录路径。 | |
npm root -g | 显示全局安装的 node_modules 目录路径。 | |
npm audit | 检查项目依赖中的安全漏洞。 | |
npm audit fix | 自动修复可修复的安全漏洞。 | |
npm doctor | 运行一系列检查,确保你的 npm 安装处于良好状态 |
四、发布与配置命令 (主要用于包作者)
命令 | 说明 | |
---|---|---|
npm login | 登录到 npm 账户。 | |
npm publish | 将当前包发布到 npm 仓库。 | |
npm version <update_type> | 根据语义化版本规则更新包的版本号(如 patch , minor , major )。 | |
npm unpublish <package_name>@<version> | (谨慎使用) 从注册表中移除某个版本的包。 | |
npm deprecate <package_name>@<version> <message> | 标记某个版本的包为已弃用。 | |
npm config set <key> <value> | 设置 npm 配置(如 npm config set registry https://registry.npmmirror.com 设置淘宝镜像)。 | |
npm config get <key> | 获取配置值。 | |
npm config list | 列出所有当前的配置 |
五、其他实用命令
命令 | 说明 | |
---|---|---|
npm cache clean --force | 强制清空 npm 的缓存。 | |
npm dedupe | 尝试简化依赖树,去除重复的包。 | |
npm repo <package_name> | 在浏览器中打开包的源码仓库(GitHub 等)。 | |
npm docs <package_name> | 在浏览器中打开包的文档。 | |
npm fund | 查看项目依赖的资助信息,支持开源作者。 |
总结与记忆技巧
-
i
= install: 大部分安装操作都可以用i
缩写。 -
-D
=--save-dev
: 记住 D 代表 Development。 -
-g
=--global
: 全局安装。 -
run
是脚本的钥匙: 任何在package.json
的scripts
里定义的命令都需要用npm run
来启动。 -
list
/view
用于查看信息: 想看看装了啥就用list
,想了解某个包就用view
。 -
特殊脚本名:
start
,test
,restart
,stop
可以直接用npm <command>
运行,无需加run
。