pnpm Cli命令总结

pnpm install

• 别名 i

命令	说明
pnpm install	安装装项目的所有依赖项
pnpm i --offline	仅下载已保存到本地镜像仓库的离线包，需要配置--offline参数
pnpm i --frozen-lockfile	不更新pnpm-lock.yaml，锁定依赖包版本号

pnpm add

从npm 注册表安装

命令	说明
pnpm add <pkg>	安装软件包以及起依赖的任何软件包,保存到 dependencies 配置项下
pnpm add -D <pkg>	保存到 devDependencies 配置项下
pnpm add -O <pkg>	保存到 optionalDependencies 配置项下
pnpm add -g <pkg>	安装软件包到全局环境中
pnpm add <pkg>@next	安装标记为 next 的版本
pnpm add <pkg>@x.x.x	安装指定版本
pnpm add <pkg>@2 react@">=0.1.0 <0.2.0"	安装指定区间内的版本

从本地文件系统上安装

从本地文件系统上安装有两种方式：

• tar 压缩包（.tar、.tar.gz 或 .tgz）

• 目录：当从目录安装时，会在当前项目 的 node_modules 目录下创建一个该目录的链接，就和执行 pnpm link 命令一样。

命令	说明
pnpm add ./pkg.tar.gz	安装软件包以及起依赖的任何软件包,保存到 dependencies 配置项下
pnpm add ./other-pkg	保存到 devDependencies 配置项下

从远端的 tar 压缩包安装

• URL 必须是一个以 “http://” 或 “https://” 开头的网络地址。

命令	说明
pnpm add https://github.com/xxxxxxxx/v1.0.0	安装软件包以及起依赖的任何软件包,保存到 dependencies 配置项下

从 Git 仓库安装

• 利用 Git 从 Git 服务提供商处 clone 并安装软件包,你可以使用特定 Git 服务提供商特定的地址协议例如 pnpm add github:user/repo

命令	说明
pnpm add <git remote url>	保存到 dependencies 配置项下

pnpm update

命令	说明
pnpm up	更新所有依赖项，遵守package.json中指定的范围
pnpm up --latest	更新所有依赖项，忽略package.json中指定的范围
pnpm up <pkg>@2	更新V2下最新版本的pkg
pnpm up "<pkg>/*"	更新pkg下的所有依赖

pnpm remove

• 别名：rm,uninstall,un

命令	说明
pnpm rm <pkg> --recursive/-r	当在 workspace下使用时，将从 workspace 下的每个软件包中删除指定的一个或多个依赖包, 当不在 workspace 下使用时，将在 子目录下寻找所有软件包并删除指定的一个或多个依赖包。
pnpm rm <pkg> --global/-g	从全局环境中删除指定的软件包。
pnpm rm <pkg> --save-dev/-D	仅删除 devDependencies 中列出的依赖包。
pnpm rm <pkg> --save-optional/-O	仅删除 optionalDependencies 中列出的依赖包。
pnpm rm <pkg> --save-prod/-P	仅删除 dependencies 中列出的依赖包。

pnpm link

• 别名： ln
• 让当前目录下的软件包在系统范围内或其它位置都可访问。

命令	说明
pnpm link <dir>	将 <dir> 目录下的软件包链接到当前目录下的 node_modules 目录下，或者通过 --dir 参数指定的目录下。
pnpm link --global	将当前工作目录或通过 --dir 参数指定的目录下的软件包链接到全局环境下的 node_modules 目录下，这样，该软件包就可以被其他软件包通过 pnpm link --global <pkg> 的方式引用了。
pnpm link --global <pkg>	将全局环境下的 node_modules 目录中的指定的软件包（<pkg>）链接到当前工作目录下（或通过 --dir 参数指定的目录下）的 node_nodules 目录下。

pnpm unlink

• 如果不指定参数的话，所有已经链接的依赖项都将被切断链接。

命令	说明
pnpm unlink	断开某个软件包在全局范围内的链接（与 pnpm link 命令的功能相反）
pnpm unlink --recursive/-r	断开子目录下的每个软件包中的链接；如果在 workspace中执行此命令的话，将断开每个 wrokspace 下的软件包中的链接。

• 此命令与 yarn unlink 类似，但 pnpm 会在删除外部链接后重新安装此依赖项

pnpm import

• pnpm import 命令用于通过其他软件包管理器的 lockfile 文件生成 pnpm-lock.yaml。支持的源文件包括：

  • package-lock.json

  • npm-shrinkwrap.json

  • yarn.lock

• 请注意，如果需要为 workspace 导入依赖项的话，所有依赖项都需要被事先声明在 pnpm-workspace.yaml 文件中。

pnpm rebuild

• 别名： rb

命令	说明
pnpm rb	重建软件包
pnpm rb --recursive/-r	在单体仓库（monorepo）下的每个软件包中执行 pnpm rebuild 命令。

pnpm prune

命令	说明
pnpm prune	删除不需要的软件包。
pnpm prune --prod	删除在 devDependencies 中列出的软件包。
pnpm prune --no-optional	删除在 optionalDependencies 中列出的软件包

pnpm install-test

• 别名：it

命令	说明
pnpm install-test	安装依赖包并运行测试(在执行 pnpm install 命令后立即执行 pnpm test 命令。此命令所能够接收的参数 与 pnpm install命令一样。)