run

Run tasks specified in turbo.json.

turbo run [tasks] [options] [-- [args passed to tasks]]

• [tasks]: Turborepo can run one or many tasks at the same time. To run a task through turbo, it must be specified in turbo.json.
• [options]: Options are used to control the behavior of the turbo run command. Available flag options are described below.
• [-- [args passed to tasks]]: You may also pass arguments to the underlying scripts. Note that all arguments will be passed to all tasks.

Options

--cache-dir <path>

Default: .turbo/cache

Specify the filesystem cache directory.

turbo run build --cache-dir="./my-cache"

--concurrency <number | percentage>

Default: 10

Set/limit the maximum concurrency for task execution. Must be an integer greater than or equal to 1 or a percentage value like 50%.

• Use 1 to force serial execution (one task at a time).
• Use 100% to use all available logical processors.
• This option is ignored if the --parallel flag is also passed.

turbo run build --concurrency=50%
turbo run test --concurrency=5

--continue

Default: false

Continue with task execution in the presence of an error (e.g. non-zero exit code from a task).

When --continue is true, turbo will exit with the highest exit code value encountered during execution.

turbo run build --continue

--cwd <path>

Default: Directory of root turbo.json

Set the working directory of the command.

turbo run build --cwd=./somewhere/else/in/your/repo

--dry / --dry-run

Instead of executing tasks, display details about the packages and tasks that would be run.

Specify --dry=json to get the output in JSON format.

Task details include useful information like (list is non-exhaustive):

--env-mode <option>

type: string

Controls the available environment variables in the task's runtime.

turbo run build --env-mode=loose

strict

Only environment variables specified in the following keys are available to the task:

• env
• passThroughEnv
• globalEnv
• globalPassThroughEnv

If Strict Mode is specified or inferred, all tasks are run in strict mode, regardless of their configuration.

loose

All environment variables on the machine are made available to the task's runtime.

--filter <string>

Specify targets to execute from your repository's graph. Multiple filters can be combined to select distinct sets of targets.

Filters can be combined to create combinations of packages, directories, and git commits.

Microsyntaxes for filtering

• !: Negate targets from the selection.
• ... using packages: Select all packages in the Package Graph relative to the target. Using ... before the package name will select dependents of the target while using ... after the package name will select dependencies of the target.
• ... using Git commits: Select a range using [<from commit>]...[<to commit>].
• ^: Omit the target from the selection when using ....

For in-depth discussion and practical use cases of filtering, visit the Running Tasks page.

Advanced filtering examples

You can combine multiple filters to further refine your targets. Multiple filters are combined as a union, meaning that the Task Graph will include tasks that match any of the filters.

# Any packages in `apps` subdirectories that have changed since the last commit
turbo run build --filter=.apps/* --filter=[HEAD^1]
 
# Any packages in `apps` subdirectories except ./apps/admin
turbo run build --filter=./apps/* --filter=!./apps/admin
 
# Run the build task for the docs and web packages
turbo run build --filter=docs --filter=web
 
# Build everything that depends on changes in branch 'my-feature'
turbo run build --filter=...[origin/my-feature]
 
# Build everything that depends on changes between two Git SHAs
turbo run build --filter=[a1b2c3d...e4f5g6h]
 
# Build '@acme/ui' if:
# - It or any of its dependencies have changed since the previous commit
turbo run build --filter=@acme/ui...[HEAD^1]
 
# Test each package that is:
# - In the '@acme' scope
# - Or, in the 'packages' directory
# - Or, changed since the previous commit
turbo run test --filter=@acme/*{./packages/*}[HEAD^1]

--force

Ignore existing cached artifacts and re-execute all tasks.

turbo run build --force

The same behavior can also be set via the TURBO_FORCE environment variable.

--framework-inference

Default: true

Specify whether or not to do Framework Inference for tasks.

When false, automatic environment variable inclusion is disabled.

turbo run build --framework-inference=false

--global-deps <file glob>

Specify glob of global filesystem dependencies to be hashed. Useful for .env and files in the root directory that impact multiple packages.

turbo run build --global-deps=".env"
turbo run build --global-deps=".env.*" --global-deps=".eslintrc" --global-deps="jest.config.js"

--graph <file type>

Default: jpg

This command will generate an svg, png, jpg, pdf, json, html, or other supported output formats of the current task graph.

If Graphviz is not installed, or no filename is provided, this command prints the dot graph to stdout.

turbo run build --graph
turbo run build test lint --graph=my-graph.svg

--log-order <option>

Default: auto

Set the ordering for log output.

By default, turbo will use grouped logs in CI environments and stream logs everywhere else. This flag is not applicable when using the terminal UI.

turbo run build --log-order=stream

--log-prefix <option>

Default: auto

Control the <package>:<task>: prefix for log lines produced when running tasks.

turbo run dev --log-prefix=none

--no-cache

Default false

Do not cache results of the task.

turbo run dev --no-cache

--no-daemon

Default: false

turbo can run a background process to pre-calculate values used for determining work that needs to be done. This standalone process (daemon) is an optimization, and not required for proper functioning of turbo.

Passing --no-daemon instructs turbo to avoid using or creating the standalone process.

--output-logs <option>

Default: full

Set type of output logging, overriding outputLogs if it's defined in turbo.json.

turbo run build --output-logs=errors-only

--only

Default: false

Restricts execution to include specified tasks only.

Example

Given this turbo.json:

{
  "$schema": "https://turbo.build/schema.json",
  "tasks": {
    "build": {
      "dependsOn": ["^build"]
    },
    "test": {
      "dependsOn": ["^build"]
    }
  }
}

turbo run test --only

The command will only execute the test tasks in each package. It will not run build.

Additionally, --only will only run tasks in specified packages, excluding dependencies. For example, turbo run build --filter=web --only, will only run the build script in the web package.

--parallel

Default: false

Run commands in parallel across packages, ignoring the task dependency graph.

turbo run lint --parallel
turbo run dev --parallel

--preflight

Only applicable when Remote Caching is configured. Enables sending a preflight request before every cache artifact and analytics request. The follow-up upload and download will follow redirects.

turbo run build --preflight

The same behavior can also be set via the TURBO_PREFLIGHT=true system variable.

--profile

Generates a trace of the run in Chrome Tracing format that you can use to analyze performance.

You must provide a verbosity flag (-v, -vv, or -vvv) with --profile to produce a trace.

turbo run build --profile=profile.json -vvv

Profiles can be viewed in a tool like Perfetto.

--remote-cache-timeout

Default: 30

Set the timeout for Remote Cache operations in seconds.

turbo run build --remote-cache-timeout=60

--remote-only

Default: false

Ignore the local filesystem cache for all tasks, using Remote Cache for reading and caching task outputs.

turbo run build --remote-only

--summarize

Generates a JSON file in .turbo/runs containing metadata about the run, including:

• Affected packages
• Executed tasks (including their timings and hashes)
• All the files included in the cached artifact

turbo run build --summarize

This flag can be helpful for debugging to determine things like:

• How turbo interpreted your glob syntax for inputs and outputs
• What inputs changed between two task runs to produce a cache miss
• How task timings changed over time

--token

A bearer token for Remote Caching. Useful for running in non-interactive shells in combination with the --team flag.

turbo run build --team=my-team --token=xxxxxxxxxxxxxxxxx

This value can also be set using the TURBO_TOKEN system variable. If both are present, the flag value will override the system variable.

--team

The slug of the Remote Cache team. Useful for running in non-interactive shells in combination with the --token flag.

turbo run build --team=my-team
turbo run build --team=my-team --token=xxxxxxxxxxxxxxxxx

This value can also be set using the TURBO_TEAM system variable. If both are present, the flag value will override the system variable.

--verbosity

To specify log level, use --verbosity=<num> or -v, -vv, -vvv.

turbo run build --verbosity=2
turbo run build -vvv