Turborepo API 参考

Turborepo 的 API 参考分为以下几个部分

配置

配置 turbo.json

配置 turbo 的行为。

包配置

为特定包创建配置。

系统环境变量

使用环境变量更改 turbo 的行为。

文件 glob 规范

定义供 turbo 使用的文件。

命令

运行

使用 turbo 运行任务。

监听

依赖感知、单进程任务监听器。

精简

为目标工作区创建部分 monorepo。

边界

在你的 monorepo 中强制执行最佳实践。

列表

列出你的 monorepo 中的包。

查询

对你的 monorepo 运行 GraphQL 查询。

生成

使用新的应用程序和包扩展你的 Turborepo。

登出

从你的远程缓存提供商登出。

链接

将你的仓库链接到远程缓存。

取消链接

断开你的仓库与远程缓存的连接。

扫描

为你的 Turborepo 启用最快的默认设置。

二进制

获取 turbo 二进制文件的路径。

遥测

管理机器的遥测。

包

create-turbo

使用示例开始使用 Turborepo。

eslint-config-turbo

查找未在 turbo.json 中列出的环境变量。

turbo-ignore

使用 turbo-ignore 跳过工作。

@turbo/gen

Turborepo 生成器的类型定义。

Flag 语法

需要值的选项可以使用等号传递，当需要空格时使用引号。

终端

--opt=value
--opt="value with a space"
--opt value
--opt "value with a space"

全局 Flag

`--color`

强制使用颜色，即使在非交互式终端中也是如此。这对于在 CI 环境（如 GitHub Actions）中启用颜色输出非常有用，这些环境支持渲染颜色。

`--no-color`

禁止终端输出中的颜色，即使在交互式终端中也是如此。

`--no-update-notifier`

禁用更新通知。此通知在 CI 环境中运行时将自动禁用，但也可以通过此标志手动禁用。

或者，你可以使用TURBO_NO_UPDATE_NOTIFIER 环境变量禁用通知。