Turborepo
API reference

Options overview

There are three ways to manage the behavior of a turbo invocation:

The three strategies listed above are in order of precedence. Where a flag value is provided, for the same System Environment Variable or turbo.json configuration, the value for the flag will be used. Because of this, we recommend using:

  • turbo.json configuration for defaults
  • System Environment Variables for per-environment overrides
  • Flags for per-invocation overrides

Options table

Caching

BehaviorFlagsEnvironment Variablesturbo.json
Force tasks to run--forceTURBO_FORCEcache
Remote Cache timeout--remote-cache-timeoutTURBO_REMOTE_CACHE_TIMEOUTremoteCache.timeout
Remote Cache upload timeout-TURBO_REMOTE_CACHE_UPLOAD_TIMEOUTremoteCache.uploadTimeout
Cache signature key-TURBO_REMOTE_CACHE_SIGNATURE_KEYsignature
Preflight request--preflightTURBO_PREFLIGHTremoteCache.preflight
Remote Cache base URL-TURBO_APIremoteCache.apiUrl
Cache sources--cacheTURBO_CACHE-
Local cache directory--cache-dirTURBO_CACHE_DIRcacheDir

Messages

BehaviorFlagsEnvironment Variablesturbo.json
Disable version print-TURBO_PRINT_VERSION_DISABLED-
Disable telemetry message-TURBO_TELEMETRY_MESSAGE_DISABLED-
Disable global turbo warning-TURBO_GLOBAL_WARNING_DISABLED-
No update notifier-TURBO_NO_UPDATE_NOTIFIER-

Task running and logs

BehaviorFlagsEnvironment Variablesturbo.json
Terminal UI--uiTURBO_UIui
Run affected tasks--affected--
Disable package manager check--dangerously-disable-package-manager-checkTURBO_DANGEROUSLY_DISABLE_PACKAGE_MANAGER_CHECKdangerouslyDisablePackageManagerCheck
Affected base ref-TURBO_SCM_BASE-
Affected head ref-TURBO_SCM_HEAD-
Only run directly specified tasks--only--
Task concurrency--concurrency--
Task log order--log-orderTURBO_LOG_ORDER-
Current working directory--cwd--
Streamed logs prefix--log-prefix--
Task logs output level--output-logs-option-outputLogs
Global inputs--global-deps-globalDependencies

Environment variables

BehaviorFlagsEnvironment Variablesturbo.json
Environment variable mode--env-mode-envMode
Vendor environment variables-TURBO_CI_VENDOR_ENV_KEY-
Framework variable exceptions--framework-inference--

Debugging outputs

BehaviorFlagsEnvironment Variablesturbo.json
Run Summaries--summarizeTURBO_RUN_SUMMARY-
Graph visualization--graph--
Dry run--dry--

Authentication

BehaviorFlagsEnvironment Variablesturbo.json
Login URL-TURBO_LOGINremoteCache.loginUrl
Team name (for multi-team Remote Cache)--teamTURBO_TEAM-
Team ID (for multi-team Remote Cache)-TURBO_TEAMID-
Authentication token--tokenTURBO_TOKEN-

Other

BehaviorFlagsEnvironment Variablesturbo.json
Binary path-TURBO_BINARY_PATH-
Download local turbo-TURBO_DOWNLOAD_LOCAL_ENABLED-
Daemon--daemon / --no-daemon-daemon

Previous

File glob specification

Next

run

hours

Total Compute Saved
Get started with
Remote Caching →

On this page

Options tableCachingMessagesTask running and logsEnvironment variablesDebugging outputsAuthenticationOther