Turborepo API reference
Turborepo's API reference is broken up into the following sections:
Configuration
Configuring turbo.json
Configure the behavior of `turbo`.
Package Configurations
Create configurations specific to a package.
System environment variables
Change `turbo`'s behavior using environment variables.
File glob specification
Define files for `turbo` to use.
Commands
run
Run tasks using `turbo`.
prune
Create partial monorepos for target workspaces.
generate
Extend your Turborepo with new apps and packages.
login
Log in to your Remote Cache provider.
logout
Log out of your Remote Cache provider.
link
Link your repository to Remote Cache.
unlink
Disconnect your repository from Remote Cache.
scan
Enable the fastest defaults for your Turborepo.
bin
Get the path to the `turbo` binary.
telemetry
Manage telemetry for the machine.
Packages
create-turbo
Get started with Turborepo using an example.
eslint-config-turbo
Find environment variables not listed in `turbo.json`.
turbo-ignore
Skip work using `turbo-ignore`.
@turbo/gen
Type definitions for Turborepo generators.
Flag syntax
Options that require a value can be passed with an equals sign, using quotes when spaces are needed.
Global flags
--color
Forces the use of color, even in non-interactive terminals. This is useful for enabling color output in CI environments like GitHub Actions that have support for rendering color.
--no-color
Suppresses color in terminal output, even in interactive terminals.
--no-update-notifier
Disables the update notification. This notification will be automatically disabled when running in CI environments, but can also be disabled manually via this flag.
Alternatively, you can disable the notification using the TURBO_NO_UPDATE_NOTIFIER
environment variable.
Was this helpful?