重要提示:此文档介绍的是 Yarn 1(经典版)。
有关 Yarn 2 以上版本的文档和迁移指南,请访问yarnpkg.com。

CLI 简介

Yarn 提供了一组丰富的命令行命令,帮助您处理 Yarn 软件包中的各个方面,包括安装、管理、发布等等。

虽然按字母顺序提供了所有可用命令,但以下是一些更流行的命令

  • yarn add:添加一个软件包以在当前软件包中使用。
  • yarn init:初始化软件包的开发。
  • yarn install:安装 package.json 文件中定义的所有依赖项。
  • yarn publish:将软件包发布到软件包管理器。
  • yarn remove:从当前软件包中移除未使用的软件包。

默认命令

在没有命令的情况下运行 yarn 将运行 yarn install,传递任何提供的标记。

用户定义脚本

运行 yarn <script> [<args>] 将运行用户定义的 script。请参阅 yarn run

本地安装的 CLI

运行 yarn <command> [<args>] 将运行该命令(如果与本地安装的 CLI 匹配)。因此,您不需要为简单用例设置用户定义的脚本。

并发和 --mutex

当以同一用户在同一服务器上运行多个 Yarn 实例时,可以通过传递全局标记 --mutex,后跟 filenetwork,确保任何给定时间只有一个实例运行(并避免冲突)。

使用 file 时,Yarn 将在当前工作目录中默认写入/读取互斥文件 .yarn-single-instance。您还可以指定备用文件名或全局文件名。

--mutex file
--mutex file:/tmp/.yarn-mutex

使用 network 时,Yarn 将在默认端口 31997 创建服务器。您还可以指定备用端口。

--mutex network
--mutex network:30330

使用 --verbose 进行详细输出

运行 yarn <command> --verbose 将打印执行的详细信息(创建目录、复制文件、HTTP 请求等)。

强制输出 ANSI 颜色

Yarn 利用 chalk 终端颜色库,并将尊重环境变量设置 FORCE_COLOR=true,例如,在终端不是 tty(例如,在 CI 环境中)时让脚本任务输出颜色。

yarn --cwd <command> 指定工作目录

指定当前工作目录,而非默认 ./。使用此标志在当前目录之外的工作目录中执行操作。

通过避免必须 cd 进入文件夹再 cd 返回,这可以让脚本变得更好。