diff --git a/docs/repo-docs/reference/system-environment-variables.mdx b/docs/repo-docs/reference/system-environment-variables.mdx index f21d1b06f0e51..cb8859dc6c8de 100644 --- a/docs/repo-docs/reference/system-environment-variables.mdx +++ b/docs/repo-docs/reference/system-environment-variables.mdx @@ -9,37 +9,320 @@ By setting certain environment variables, you can change Turborepo's behavior. T System environment variables are always overridden by flag values provided directly to your `turbo` commands. -| Variable | Description | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `TURBO_API` | Set the base URL for [Remote Cache](/repo/docs/core-concepts/remote-caching). | -| `TURBO_BINARY_PATH` | Manually set the path to the `turbo` binary. By default, `turbo` will automatically discover the binary so you should only use this in rare circumstances. | -| `TURBO_CACHE` | Control reading and writing for cache sources. Uses the same syntax as [`--cache`](/repo/docs/reference/run#--cache-options). | -| `TURBO_CACHE_DIR` | Sets the cache directory, similar to using [`--cache-dir`](/repo/docs/reference/run#--cache-dir-path) flag | -| `TURBO_CI_VENDOR_ENV_KEY` | Set a prefix for environment variables that you want **excluded** from [Framework Inference](/repo/docs/crafting-your-repository/using-environment-variables#framework-inference). **NOTE**: This does not need to be set by the user and should be configured automatically by supported platforms. | -| `TURBO_DANGEROUSLY_DISABLE_PACKAGE_MANAGER_CHECK` | Disable checking the `packageManager` field in `package.json`. You may run into [errors and unexpected caching behavior](/repo/docs/reference/run#--dangerously-disable-package-manager-check) when disabling this check. Use `true` or `1` to disable. | -| `TURBO_DOWNLOAD_LOCAL_ENABLED` | Enables global `turbo` to install the correct local version if one is not found. | -| `TURBO_FORCE` | Set to `true` to force all tasks to run in full, opting out of all caching. | -| `TURBO_GLOBAL_WARNING_DISABLED` | Disable warning when global `turbo` cannot find a local version to use. | -| `TURBO_PRINT_VERSION_DISABLED` | Disable printing the version of `turbo` that is being executed. | -| `TURBO_LOG_ORDER` | Set the [log order](/repo/docs/reference/run#--log-order-option). Allowed values are `grouped` and `default`. | -| `TURBO_LOGIN` | Set the URL used to log in to [Remote Cache](/repo/docs/core-concepts/remote-caching). | -| `TURBO_NO_UPDATE_NOTIFIER` | Remove the update notifier that appears when a new version of `turbo` is available. You can also use `NO_UPDATE_NOTIFIER` per ecosystem convention. | -| `TURBO_PLATFORM_ENV` | A CSV of environment variable keys that are configured in a supported CI environment (Vercel). **NOTE**: This does not need to be set by the user and should be configured automatically by supported platforms. | -| `TURBO_PLATFORM_ENV_DISABLED` | Disable checking environment variables configured in your `turbo.json` against those set on your supported platform | -| `TURBO_PREFLIGHT` | Enables sending a preflight request before every cache artifact and analytics request. The follow-up upload and download will follow redirects. Only applicable when [Remote Caching](/repo/docs/core-concepts/remote-caching) is configured. | -| `TURBO_REMOTE_CACHE_READ_ONLY` | Prevent writing to the [Remote Cache](/repo/docs/core-concepts/remote-caching) - but still allow reading. | -| `TURBO_REMOTE_CACHE_SIGNATURE_KEY` | Sign artifacts with a secret key. For more information, visit [the Artifact Integrity section](/repo/docs/core-concepts/remote-caching#artifact-integrity-and-authenticity-verification). | -| `TURBO_REMOTE_CACHE_TIMEOUT` | Set a timeout in seconds for `turbo` to get artifacts from [Remote Cache](/repo/docs/core-concepts/remote-caching). | -| `TURBO_REMOTE_CACHE_UPLOAD_TIMEOUT` | Set a timeout in seconds for `turbo` to upload artifacts to [Remote Cache](/repo/docs/core-concepts/remote-caching). | -| `TURBO_REMOTE_ONLY` | Always ignore the local filesystem cache for all tasks. | -| `TURBO_RUN_SUMMARY` | Generate a [Run Summary](/repo/docs/reference/run#--summarize) when you run tasks. | -| `TURBO_SCM_BASE` | Base used by `--affected` when calculating what has changed from `base...head` | -| `TURBO_SCM_HEAD` | Head used by `--affected` when calculating what has changed from `base...head` | -| `TURBO_TEAM` | The account name associated with your repository. When using [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching#vercel-remote-cache), this is your team's slug. | -| `TURBO_TEAMID` | The account identifier associated with your repository. When using [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching#vercel-remote-cache), this is your team's ID. | -| `TURBO_TELEMETRY_MESSAGE_DISABLED` | Disable the message notifying you that [Telemetry](/repo/docs/telemetry) is enabled. | -| `TURBO_TOKEN` | The Bearer token for authentication to access [Remote Cache](/repo/docs/core-concepts/remote-caching). | -| `TURBO_UI` | Enables TUI when passed true or 1, disables when passed false or 0. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VariableDescription
+ TURBO_API + + Set the base URL for{' '} + Remote Cache. +
+ + TURBO_BINARY_PATH + + + Manually set the path to the turbo binary. By default,{' '} + turbo will automatically discover the binary so you should + only use this in rare circumstances. +
+ + TURBO_CACHE + + + Control reading and writing for cache sources. Uses the same syntax as{' '} + + --cache + + . +
+ TURBO_CACHE_DIR + + Sets the cache directory, similar to using{' '} + + --cache-dir + {' '} + flag +
+ TURBO_CI_VENDOR_ENV_KEY + + Set a prefix for environment variables that you want{' '} + excluded from{' '} + + Framework Inference + + . NOTE: This does not need to be set by the user and should + be configured automatically by supported platforms. +
+ TURBO_DANGEROUSLY_DISABLE_PACKAGE_MANAGER_CHECK + + Disable checking the packageManager field in{' '} + package.json. You may run into{' '} + + errors and unexpected caching behavior + {' '} + when disabling this check. Use true or 1 to + disable. +
+ TURBO_DOWNLOAD_LOCAL_ENABLED + + Enables global turbo to install the correct local version + if one is not found. +
+ TURBO_FORCE + + Set to true to force all tasks to run in full, opting out + of all caching. +
+ TURBO_GLOBAL_WARNING_DISABLED + + Disable warning when global turbo cannot find a local + version to use. +
+ TURBO_PRINT_VERSION_DISABLED + + Disable printing the version of turbo that is being + executed. +
+ TURBO_LOG_ORDER + + Set the{' '} + log order. + Allowed values are grouped and default. +
+ TURBO_LOGIN + + Set the URL used to log in to{' '} + Remote Cache. +
+ TURBO_NO_UPDATE_NOTIFIER + + Remove the update notifier that appears when a new version of{' '} + turbo is available. You can also use{' '} + NO_UPDATE_NOTIFIER per ecosystem convention. +
+ TURBO_PLATFORM_ENV + + A CSV of environment variable keys that are configured in a supported CI + environment (Vercel). NOTE: This variable is meant for + platforms looking to implement zero-configuration environment variables. + You are not meant to use this variable as an end user.{' '} +
+ TURBO_PLATFORM_ENV_DISABLED + + Disable checking environment variables configured in your{' '} + turbo.json against those set on your supported platform +
+ TURBO_PREFLIGHT + + Enables sending a preflight request before every cache artifact and + analytics request. The follow-up upload and download will follow + redirects. Only applicable when{' '} + Remote Caching is + configured. +
+ TURBO_REMOTE_CACHE_READ_ONLY + + Prevent writing to the{' '} + Remote Cache - but + still allow reading. +
+ TURBO_REMOTE_CACHE_SIGNATURE_KEY + + Sign artifacts with a secret key. For more information, visit{' '} + + the Artifact Integrity section + + . +
+ TURBO_REMOTE_CACHE_TIMEOUT + + Set a timeout in seconds for turbo to get artifacts from{' '} + Remote Cache. +
+ TURBO_REMOTE_CACHE_UPLOAD_TIMEOUT + + Set a timeout in seconds for turbo to upload artifacts to{' '} + Remote Cache. +
+ TURBO_REMOTE_ONLY + Always ignore the local filesystem cache for all tasks.
+ TURBO_RUN_SUMMARY + + Generate a{' '} + Run Summary when you + run tasks. +
+ TURBO_SCM_BASE + + Base used by --affected when calculating what has changed + from base...head +
+ TURBO_SCM_HEAD + + Head used by --affected when calculating what has changed + from base...head +
+ TURBO_TEAM + + The account name associated with your repository. When using{' '} + + Vercel Remote Cache + + , this is your team's slug. +
+ TURBO_TEAMID + + The account identifier associated with your repository. When using{' '} + + Vercel Remote Cache + + , this is your team's ID. +
+ TURBO_TELEMETRY_MESSAGE_DISABLED + + Disable the message notifying you that{' '} + Telemetry is enabled. +
+ TURBO_TOKEN + + The Bearer token for authentication to access{' '} + Remote Cache. +
+ TURBO_UI + + Enables TUI when passed true or 1, disables when passed false or 0. +
## Environment variables in tasks