Configuration

系统环境变量

通过设置特定的环境变量来改变 Turborepo 的行为,为不同环境和机器创建特定配置

通过设置特定的环境变量,您可以改变 Turborepo 的行为。这对于为不同环境和机器创建特定配置非常有用。

系统环境变量总是会被直接提供给 turbo 命令的标志值覆盖。

变量描述
FORCE_COLOR强制在终端日志中显示颜色
TURBO_API设置 远程缓存 的基础 URL。
TURBO_BINARY_PATH手动设置 turbo 二进制文件的路径。默认情况下,turbo 会自动发现二进制文件,因此您只应在极少数情况下使用此选项。
TURBO_CACHE控制缓存源的读取和写入。使用与 --cache 相同的语法。
TURBO_CACHE_DIR设置缓存目录,类似于使用 --cache-dir 标志。
TURBO_CI_VENDOR_ENV_KEY为您希望从 框架推断排除的环境变量设置前缀。注意:这不需要用户设置,应该由支持的平台自动配置。
TURBO_DANGEROUSLY_DISABLE_PACKAGE_MANAGER_CHECK禁用检查 package.json 中的 packageManager 字段。禁用此检查时,您可能会遇到 错误和意外的缓存行为。使用 true1 来禁用。
TURBO_DOWNLOAD_LOCAL_ENABLED启用全局 turbo 在找不到本地版本时安装正确的本地版本。
TURBO_FORCE设置为 true 以强制所有任务完整运行,选择退出所有缓存。
TURBO_GLOBAL_WARNING_DISABLED当全局 turbo 找不到要使用的本地版本时禁用警告。
TURBO_PRINT_VERSION_DISABLED禁用打印正在执行的 turbo 版本。
TURBO_LOG_ORDER设置 日志顺序。允许的值为 groupeddefault
TURBO_LOGIN设置用于登录 远程缓存 的 URL。仅对实现动态创建令牌端点的自托管远程缓存需要。
TURBO_NO_UPDATE_NOTIFIER移除当有新版本 turbo 可用时出现的更新通知器。您也可以按照生态系统约定使用 NO_UPDATE_NOTIFIER
TURBO_PLATFORM_ENV在支持的 CI 环境(Vercel)中配置的环境变量键的 CSV。注意:此变量适用于希望实现零配置环境变量的平台。作为最终用户,您不应该使用此变量。
TURBO_PLATFORM_ENV_DISABLED禁用检查您的 turbo.json 中配置的环境变量与您支持的平台上设置的环境变量
TURBO_PREFLIGHT启用在每个缓存工件和分析请求之前发送预检请求。后续的上传和下载将遵循重定向。仅在配置了 远程缓存 时适用。
TURBO_REMOTE_CACHE_READ_ONLY防止写入 远程缓存 - 但仍允许读取。
TURBO_REMOTE_CACHE_SIGNATURE_KEY使用密钥签名工件。有关更多信息,请访问 工件完整性部分
TURBO_REMOTE_CACHE_TIMEOUTturbo远程缓存 获取工件设置超时时间(秒)。
TURBO_REMOTE_CACHE_UPLOAD_TIMEOUTturbo 上传工件到 远程缓存 设置超时时间(秒)。
TURBO_REMOTE_ONLY始终忽略所有任务的本地文件系统缓存。
TURBO_RUN_SUMMARY运行任务时生成 运行摘要
TURBO_SCM_BASE--affected 在计算从 base...head 更改的内容时使用的基础
TURBO_SCM_HEAD--affected 在计算从 base...head 更改的内容时使用的头部
TURBO_TEAM与您的仓库关联的账户名称。使用 Vercel 远程缓存 时,这是您团队的 slug。
TURBO_TEAMID与您的仓库关联的账户标识符。使用 Vercel 远程缓存 时,这是您团队的 ID。
TURBO_TELEMETRY_MESSAGE_DISABLED禁用通知您 遥测 已启用的消息。
TURBO_TOKEN用于访问 远程缓存 的身份验证 Bearer 令牌。
TURBO_UI当传递 true 或 1 时启用 TUI,当传递 false 或 0 时禁用。
TURBO_CONCURRENCY控制运行或监视模式下的 并发 设置。
TURBO_SSO_LOGIN_CALLBACK_PORT覆盖身份验证期间 SSO 登录回调服务器使用的默认端口(9789)。

任务中的环境变量

Turborepo 将在任务执行时在您的任务中提供以下环境变量:

变量描述
TURBO_HASH当前运行任务的哈希值。
TURBO_IS_TUI使用 TUI 时,此变量设置为 true