turbo.build

# Turborepo documentation

Generated at: Thu, 17 Sep 2026 20:54:00 GMT

> Turborepo is the build system for coding agents. It provides incremental task running, local and remote caching, and parallel execution.

## When to use Turborepo

- Category: Build system
- Audience: JavaScript and TypeScript developers, Monorepo maintainers, Platform and developer experience teams

Common use cases:

- Run tasks across a monorepo with caching and parallelism
- Share build caches locally and remotely (Remote Caching)
- Configure task pipelines in turbo.json
- Prune monorepos for lightweight deploys

## Docs

- [Introduction](/docs/index.md): Welcome to the Turborepo documentation!
- [Acknowledgements](/docs/acknowledgments.md): Thank you to all these developers, build systems, and monorepo tools for their support and assistance.
- [Community](/docs/community.md): Learn about the Turborepo community.
- [Core concepts](/docs/core-concepts.md): Learn about the core concepts behind Turborepo.
- [Internal Packages](/docs/core-concepts/internal-packages.md): Learn how to build Internal Packages in your monorepo.
- [Package and Task Graphs](/docs/core-concepts/package-and-task-graph.md): Turborepo builds a Task Graph based on your configuration and repository structure.
- [Package types](/docs/core-concepts/package-types.md): Learn about the different types of packages in a workspace.
- [Remote Caching](/docs/core-concepts/remote-caching.md): Share cache artifacts across machines for even faster builds.
- [Crafting your repository](/docs/crafting-your-repository.md): Design and build your Turborepo.
- [Caching](/docs/crafting-your-repository/caching.md): Learn about caching in Turborepo.
- [Configuring tasks](/docs/crafting-your-repository/configuring-tasks.md): Learn how to describe the workflows in your repository to get them done as fast as possible.
- [Constructing CI](/docs/crafting-your-repository/constructing-ci.md): Learn how Turborepo can help you efficiently complete all the necessary tasks and accelerate your development workflow.
- [Creating an Internal Package](/docs/crafting-your-repository/creating-an-internal-package.md): Learn how to create an Internal Package for your monorepo.
- [Developing applications](/docs/crafting-your-repository/developing-applications.md): Learn how to develop applications in your repository.
- [Managing dependencies](/docs/crafting-your-repository/managing-dependencies.md): Learn how to manage dependencies in your monorepo's workspace.
- [Running tasks](/docs/crafting-your-repository/running-tasks.md): Learn how to run tasks in your repository through the `turbo` CLI.
- [Structuring a repository](/docs/crafting-your-repository/structuring-a-repository.md): Start by creating a repository using the conventions of the ecosystem.
- [Understanding your repository](/docs/crafting-your-repository/understanding-your-repository.md): Learn how to understand your repository structure using Turborepo.
- [Upgrading](/docs/crafting-your-repository/upgrading.md): Learn how to upgrade `turbo` to get the latest improvements to your repository.
- [Using environment variables](/docs/crafting-your-repository/using-environment-variables.md): Learn how to handle environments for your applications.
- [Getting started](/docs/getting-started.md): Get started with Turborepo.
- [Add to an existing repository](/docs/getting-started/add-to-existing-repository.md): Using Turborepo with your existing repository
- [Editor integration](/docs/getting-started/editor-integration.md): Making the most of Turborepo
- [Start with an example](/docs/getting-started/examples.md): Start with an example Turborepo.
- [Installation](/docs/getting-started/installation.md): Learn how to get started with Turborepo.
- [Guides](/docs/guides.md): Learn how to use your favorite tooling in a Turborepo.
- [Using AI with Turborepo](/docs/guides/ai.md): Get the most out of AI coding assistants in your Turborepo.
- [Continuous Integration](/docs/guides/ci-vendors.md): Recipes for using Turborepo with Vercel, GitHub Actions, and other continuous integration providers.
- [Buildkite](/docs/guides/ci-vendors/buildkite.md): Learn how to use Buildkite with Turborepo.
- [CircleCI](/docs/guides/ci-vendors/circleci.md): Learn how to use CircleCI with Turborepo.
- [GitHub Actions](/docs/guides/ci-vendors/github-actions.md): Learn how to use GitHub Actions with Turborepo.
- [GitLab CI](/docs/guides/ci-vendors/gitlab-ci.md): Learn how to use GitLab CI with Turborepo.
- [Travis CI](/docs/guides/ci-vendors/travis-ci.md): How to use Travis CI with Turborepo to optimize your CI workflow
- [Vercel](/docs/guides/ci-vendors/vercel.md): Learn how to use Turborepo on Vercel.
- [Coordinating development runtime dependencies](/docs/guides/coordinating-runtime-dependencies.md): Learn how to coordinate development services that depend on each other at runtime.
- [Frameworks](/docs/guides/frameworks.md): Integrate your favorite framework into Turborepo.
- [Framework bindings in libraries](/docs/guides/frameworks/framework-bindings.md): Learn how to create framework bindings in packages.
- [Next.js](/docs/guides/frameworks/nextjs.md): Learn how to use Next.js in a monorepo.
- [Nuxt](/docs/guides/frameworks/nuxt.md): Learn more about using Nuxt in your monorepo.
- [Rsbuild](/docs/guides/frameworks/rsbuild.md): Learn more about using Rsbuild in your monorepo.
- [SvelteKit](/docs/guides/frameworks/sveltekit.md): Learn more about using SvelteKit in your monorepo.
- [Vite](/docs/guides/frameworks/vite.md): Learn more about using Vite in your monorepo.
- [Generating code](/docs/guides/generating-code.md): Learn how to generate code using Turborepo.
- [Handling platforms](/docs/guides/handling-platforms.md): Learn how to handle caching around operating systems, architectures, and other arbitrary conditions for Turborepo tasks.
- [Microfrontends](/docs/guides/microfrontends.md): Learn how to use Turborepo's built-in microfrontends proxy for local development.
- [Migrating from Nx](/docs/guides/migrating-from-nx.md): Learn how to migrate to Turborepo from Nx.
- [Multi-language support](/docs/guides/multi-language.md): Combine package-manager and native language workspaces.
- [Publishing libraries](/docs/guides/publishing-libraries.md): Learn how to publish libraries to the npm registry from a monorepo.
- [Single-package workspaces](/docs/guides/single-package-workspaces.md): Learn how to use Turborepo in a single-package workspace.
- [Skipping tasks](/docs/guides/skipping-tasks.md): Never do the same work twice.
- [Tools](/docs/guides/tools.md): Learn how to use your favorite tools in a monorepo.
- [Biome](/docs/guides/tools/biome.md): Learn how to use Biome in your Turborepo projects.
- [Docker](/docs/guides/tools/docker.md): Learn how to use Docker in a monorepo.
- [ESLint](/docs/guides/tools/eslint.md): Learn how to use ESLint in a monorepo.
- [Go (Experimental)](/docs/guides/tools/go.md): Use experimental native Go workspace support with Turborepo.
- [Jest](/docs/guides/tools/jest.md): Learn how to use Jest in a Turborepo.
- [Oxc (oxlint and oxfmt)](/docs/guides/tools/oxc.md): Learn how to use oxlint and oxfmt in your Turborepo projects.
- [Playwright](/docs/guides/tools/playwright.md): Learn how to use Playwright in a Turborepo.
- [Prisma](/docs/guides/tools/prisma.md): Learn how to use Prisma in a Turborepo.
- [Python (Experimental)](/docs/guides/tools/python.md): Use experimental native uv workspace support with Turborepo.
- [Rust (Experimental)](/docs/guides/tools/rust.md): Use experimental native Cargo workspace support with Turborepo.
- [shadcn/ui](/docs/guides/tools/shadcn-ui.md): Learn how to use shadcn/ui in a Turborepo.
- [Storybook](/docs/guides/tools/storybook.md): Learn how to use Storybook in a Turborepo.
- [Tailwind CSS](/docs/guides/tools/tailwind.md): Learn how to use Tailwind CSS in a Turborepo.
- [TypeScript](/docs/guides/tools/typescript.md): Learn how to use TypeScript in a monorepo.
- [Vitest](/docs/guides/tools/vitest.md): Learn how to use Vitest in a monorepo.
- [Invalid environment variable prefix](/docs/messages/invalid-env-prefix.md): Learn more about errors with invalid environment variable prefixes in Turborepo.
- [Missing root task in turbo.json](/docs/messages/missing-root-task-in-turbo-json.md): Learn more about errors for missing root tasks in turbo.json in Turborepo.
- [Package task in single-package workspace error](/docs/messages/package-task-in-single-package-workspace.md): Learn more about errors with package tasks in single-package workspaces.
- [Recursive `turbo` invocations](/docs/messages/recursive-turbo-invocations.md): Learn more about errors with recursive scripts and tasks in Turborepo.
- [Unnecessary package task syntax error](/docs/messages/unnecessary-package-task-syntax.md): Learn more about errors with unnecessary package task syntax in Turborepo.
- [Remote Cache API](/docs/openapi.md): OpenAPI specification for self-hosted Remote Cache servers.
- [Artifacts](/docs/openapi/artifacts.md): Endpoints for managing cache artifacts.
- [Check if artifact exists](/docs/openapi/artifacts/artifact-exists.md): Check that a cache artifact with the given `hash` exists. This request returns response headers only and is equivalent to a `GET` request to this endpoint where the response contains no body.

Implementers should return 200 if the artifact exists, or 404 if it does not.
- [Query artifact information](/docs/openapi/artifacts/artifact-query.md): Query information about multiple artifacts by their hashes. Returns metadata about each artifact including size, task duration, and tag.

This endpoint is optional for basic cache functionality but enables optimized cache fetching by allowing the client to query multiple artifacts in a single request.
- [Download a cache artifact](/docs/openapi/artifacts/download-artifact.md): Downloads a cache artifact identified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream (binary data).

The artifact data is a gzip-compressed tarball containing the cached task outputs. The client will verify the content-length header against the response body size.
- [Record cache usage events](/docs/openapi/artifacts/record-events.md): Records cache usage analytics events. The body of this request is an array of cache usage events.

This endpoint is optional but enables cache hit/miss analytics. Implementers can use this data to track cache effectiveness and optimize storage.

Event types:
- `HIT`: A cached artifact was found and used
- `MISS`: No cached artifact was found for the given hash

Source types:
- `LOCAL`: The cache event was on the user's local filesystem cache
- `REMOTE`: The cache event is for the remote cache
- [Get remote caching status](/docs/openapi/artifacts/status.md): Check the status of Remote Caching for the authenticated user or team. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits.

Implementers should return `enabled` if the authenticated principal is allowed to use the cache, or `disabled` if not. The `over_limit` and `paused` statuses are optional and can be used to indicate usage limits or temporary suspension.
- [Upload a cache artifact](/docs/openapi/artifacts/upload-artifact.md): Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`.

The request body should contain a gzip-compressed tarball of the task outputs. The server should store this data and make it available for subsequent downloads.
- [Turborepo API reference](/docs/reference.md): Learn about Turborepo's APIs using the reference.
- [bin](/docs/reference/bin.md): API reference for the `turbo bin` command
- [boundaries](/docs/reference/boundaries.md): API reference for the `turbo boundaries` command
- [Configuring turbo.json](/docs/reference/configuration.md): Learn how to configure Turborepo through `turbo.json`.
- [create-turbo](/docs/reference/create-turbo.md): Quickly set up a new Turborepo repository from scratch.
- [devtools](/docs/reference/devtools.md): API reference for the `turbo devtools` command
- [docs](/docs/reference/docs.md): API reference for the `turbo docs` command
- [eslint-config-turbo](/docs/reference/eslint-config-turbo.md): Learn more about eslint-config-turbo.
- [eslint-plugin-turbo](/docs/reference/eslint-plugin-turbo.md): Learn more about eslint-plugin-turbo.
- [generate](/docs/reference/generate.md): API reference for the `turbo generate` command
- [File glob specification](/docs/reference/globs.md): Learn about the file glob specification used by `turbo`.
- [info](/docs/reference/info.md): API reference for the `turbo info` command
- [link](/docs/reference/link.md): API reference for the `turbo link` command
- [login](/docs/reference/login.md): API reference for the `turbo login` command
- [logout](/docs/reference/logout.md): API reference for the `turbo logout` command
- [ls](/docs/reference/ls.md): API reference for the `turbo ls` command
- [Options overview](/docs/reference/options-overview.md): Flags, configurations, and System Environment Variables for Turborepo
- [Package Configurations](/docs/reference/package-configurations.md): Learn how to use Package Configurations to bring greater task flexibility to your monorepo's package.
- [prune](/docs/reference/prune.md): API reference for the `turbo prune` command
- [query](/docs/reference/query.md): API reference for the `turbo query` command
- [run](/docs/reference/run.md): API reference for the `turbo run` command
- [scan (Deprecated)](/docs/reference/scan.md): API reference for the deprecated `turbo scan` command
- [System environment variables](/docs/reference/system-environment-variables.md): Learn about system variables used by Turborepo.
- [telemetry](/docs/reference/telemetry.md): API reference for the `turbo telemetry` command
- [@turbo/codemod](/docs/reference/turbo-codemod.md): Learn more about how Turborepo uses codemods to make version migrations easy.
- [@turbo/gen](/docs/reference/turbo-gen.md): Quickly generate new code in your Turborepo.
- [turbo-ignore](/docs/reference/turbo-ignore.md): Learn how to use turbo-ignore to skip tasks in CI.
- [unlink](/docs/reference/unlink.md): API reference for the `turbo unlink` command
- [watch](/docs/reference/watch.md): API reference for the `watch` command
- [Support policy](/docs/support-policy.md): Learn about Turborepo's Support policy.
- [Telemetry](/docs/telemetry.md): Learn more about Turborepo's anonymous telemetry.