npx 使用教程

一、简介

npx是一个工具，npm 从 v5.2.0 开始新增了 npx 命令，>= 该版本会自动安装 npx，是一个npm包执行器，旨在提高从npm注册表使用软件包的体验 ，npm 使得它非常容易地安装和管理托管在注册表上的依赖项，npx 使得使用 CLI 工具和其他托管在注册表，加强了用户的体验。

Node安装后自带npm模块，可以直接使用npx命令。如果不能使用，就要手动安装一下。

npm install -g npx

1、特点

使用 npx 命令，默认情况下，首先检查路径中是否存在要执行的包（即在项目中），如果存在，它将执行。若不存在，意味着尚未安装该软件包，npx将安装其最新版本，然后执行它。 

1、临时安装可执行依赖包，不用全局安装，不用担心长期的污染。
2、可以执行依赖包中的命令，安装完成自动运行。
3、自动加载node_modules中依赖包，不用指定$PATH。
4、可以指定node版本、命令的版本，解决了不同项目使用不同版本的命令的问题。

2、npx 与 npm 的区别

npx：临时安装并执行某个包的一个工具

npm：Node.js提供的一个包管理器, 可以使用 NPM 来安装 node.js 包。但 npm 可以通过 scripts 配置来达到 npx 的效果

当执行 $ npx <command> 相关命令的时候，npx 会先本地找（可以是项目中的也可以是本机的）寻找这个 command。

• 找到了：就用本地的版本
• 没找到：直接下载最新版本（这里是在缓存里），完成命令要求
• 使用完之后就会完全清除，不会在本机或项目留下任何东西
• 这样就不会污染本机、永远使用最新版本的 dependency

二、使用场景

1、调用项目内部安装的模块

npx 想要解决的主要问题，就是调用项目内部安装的模块。

比如，项目内部安装了测试工具webpack。

# 非全局安装
npm install webpack -D

如果我们查看webpack的版本，需用命令：

# 项目的根目录下执行
node-modules/.bin/webpack -v

改用 npx：

npx webpack -v

即 npx 可以直接调用项目内部安装的模块。

npx 的原理，就是运行的时候，会到node_modules/.bin路径和环境变量$PATH里面，检查命令是否存在。

由于 npx 会检查环境变量$PATH，所以系统命令也可以调用。

2、避免全局安装模块，只想临时使用

比如：create-react-app 这个模块是全局安装，npx 可以运行它，而且不进行全局安装。

npx create-react-app my-react-app

上面代码运行时，npx 将 create-react-app 下载到一个临时目录，使用以后再删除。

所以以后再次执行上面的命令，会重新下载 create-react-app 提供使用后再移除。

3、下载全局模块时，npx 允许指定版本

指定使用 v4.44.1 版本的 webpack 进行打包操作。

npx webpack@4.44.1 ./src/index.js -o ./dist/main.js

4、—no–install 参数和 —ignore-existing 参数

注意：只要 npx 后面的模块无法在本地发现，就会下载同名模块。

比如：本地没有安装 webpack–dev–server 模块，下面的命令会自动下载该模块，在当前目录启动一个 Webpack dev 服务。

npx webpack-dev-server

4.1 强制使用本地模块，不下载远程模块

如果想让 npx 强制使用本地模块，不下载远程模块，可以使用 —no–install 参数，如果本地不存在该模块，就会报错：

npx --no-install webpack-dev-server

4.2 忽略本地的同名模块，强制使用远程模块

如果本地存在同名的模块，但是还是想使用远程的新版本模块，可以使用 —ignore-existing 参数。

比如：本地已经全局安装了 create–react–app，但还是想使用远程模块，就用这个参数：

npx --ignore-existing create-react-app my-react-app

5、使用不同版本的 node

npx node@14.15.0 -v

• 上面命令会使用 v14.15.0 版本的 node 执行脚本。原理是从 npm 下载这个版本的 node，使用后再删掉。

• 在某些场景下，这个方法用来切换 node 版本，要比 nvm 那样的版本管理器方便一些。

 TIP：切换 node 版本的工具，可以用 npx 或 nvm。

关于nvm的教程，更多具体内容可以参考这篇博客：nrm 和 nvm 在项目中的使用_不怕麻烦的鹿丸的博客-CSDN博客

5.1 解决 npm WARN old lockfile package–lock.json 的问题

在一些旧的项目中，之前的项目依赖是使用旧版本的 npm 安装的，然后当前我们的开发环境安装的npm版本又是新版本的时候，当我们在运行 npm ci 步骤时，会有一个警告 npm WARN old lockfile The package-lock.json 即提示文件是用旧版本的 npm 创建的。

除了降级npm的版本到旧项目中的旧版本外。如果已经安装了npm 新的版本，但想保留当前新版本，同时使用旧版本的npm 运行命令，就可以使用 npx 来去做。

npx npm@6 ci

上面的命令，将使用 npm 版本6来 运行 npm ci，即使你已经安装了新版本 npm。

6、-p 参数 —— 指定 npx 所要安装的模块

先指定安装 node@0.12.8，然后再执行 node -v 命令

npx -p node@0.12.8 node -v 

-p 参数对于需要安装多个模块的场景很有用

npx -p lolcatjs -p cowsay [command]

7、-c 参数 —— 所有命令都用 npx 解释

7.1 将所有命令都用 npx 解释

例如执行下方命令，只有第一个可执行项会使用 npx 安装的模块，后面的可执行项还是会交给 Shell 解释

npx -p lolcatjs -p cowsay 'cowsay hello | lolcatjs'

# 报错

上面代码中，cowsay hello | lolcatjs执行时会报错，原因是第一项cowsay由 npx 解释，而第二项命令localcatjs由 Shell 解释，但是lolcatjs并没有全局安装，所以报错。

改用-c参数就可以

npx -p lolcatjs -p cowsay -c 'cowsay hello | lolcatjs'

7.2 将环境变量带入所要执行的命令

npm 提供当前项目的一些环境变量，可以用下面的命令查看。

npm run env | grep npm_

-c 参数可以把这些 npm 的环境变量带入 npx 命令。

# 输出当前项目的项目名
npx -c 'echo "$npm_package_name"'

8、执行 GitHub 源码

# 执行 Gist 代码
$ npx https://gist.github.com/zkat/4bc19503fe9e9309e2bfaa2c58074d32
 
# 执行仓库代码
$ npx github:piuccio/cowsay hello

注意：远程代码必须是一个模块，即必须包含 package.json 和入口脚本。

9、已全局安装某个包，项目又已安装了不同版本的某个包，想用另外的版本

比如，本地已经全局安装了Vue脚手架的@2.x.x版本, 但是想用并已经在本地项目文件目录中安装了最新的@4.x.x版本, 即：

# 以vue-cli为例:
npx vue create my-project

三、npx的一些参数

1、安装并使用特定版本：npx 包@版本号 包对应的命令

2、--no-install 强制使用本地包, 本地包如果没安装就会报错：npx --no-install vue create my-project

3、--ignore-existing 强制安装使用远程模块：npx --ignore-existing vue create my-project

4、-p 对于一次性安装多个包,使用参数-p：npx -p @vue/cli -p less 

切记：安装多个包一定要使用 -p

5、-c 在一次性安装并使用多个包的场景中，在低版本下执行 npx -p vue-cli -p less lessc -v & vue -V 命令, 有可能只有第一个命令项能正常执行，即只打印出less编辑器的版本。npx的参数-c就是为了告诉npx执行指定的所有命令的范围：npx -p vue-cli -p less -c "lessc -v & vue -V", 这样就能保证绝对的安全了。

注：&代表两个命令都执行, |代表前面执行成功后面命令就不执行。

不管安装的包、命令的个数个数是多少（哪怕只安装1个包）， 严格遵守

npx -p 包1 -p 包2 -p 包n -c "命令1 & 命令2 & 命令n" 一定没错 

代码007普通

打赏 收藏 海报 链接