Turborepo API 参考

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

配置

配置 turbo.json

配置 `turbo` 的行为。

包配置

创建特定于包的配置。

系统环境变量

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

文件 glob 规范

定义供 `turbo` 使用的文件。

命令

run

使用 `turbo` 运行任务。

watch

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

prune

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

boundaries

在你的 monorepo 中实施最佳实践。

ls

列出你的 monorepo 中的包。

query

针对你的 monorepo 运行 GraphQL 查询。

generate

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

login

登录到你的远程缓存提供程序。

logout

登出你的远程缓存提供程序。

link

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

unlink

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

scan

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

bin

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

telemetry

管理机器的遥测。

包

create-turbo

通过示例开始使用 Turborepo。

eslint-config-turbo

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

turbo-ignore

使用 `turbo-ignore` 跳过工作。

@turbo/gen

Turborepo 生成器的类型定义。

标志语法

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

终端

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

全局标志

`--color`

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

`--no-color`

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

`--no-update-notifier`

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

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