Add Turborepo to your existing project

Turborepo can be used in any project to speed up the execution of scripts in your package.json.

After you install turbo, you'll be able to run all your package.json tasks from turbo instead of your package manager.

By configuring your turbo.json correctly, you'll notice how caching helps your tasks run a lot faster.

Quickstart

1. Install turbo globally

npm install turbo --global

For more details about installation, see Installing Turborepo

2. Add a turbo.json file at the base of your repository:

For more information on configuring your turbo.json, see the Configuration Options documentation.

{
  "$schema": "https://turbo.build/schema.json",
  "pipeline": {
    "build": {
      "outputs": [".next/**", "!.next/cache/**"]
    },
    "type-check": {}
  }
}

3. Edit .gitignore

Add .turbo to your .gitignore file. The CLI uses these folders for logs and certain task outputs.

+ .turbo

4. Run the type-check and build tasks with turbo:

turbo type-check build

This runs type-check and build at the same time.

5. Without making any changes to the code, try running type-check and build again:

turbo type-check build

You should see terminal output like this:

 Tasks:    2 successful, 2 total
Cached:    2 cached, 2 total
  Time:    185ms >>> FULL TURBO

Congratulations - you just completed a type check and build in under 200ms.

To learn how this is possible, check out our core concepts docs.

6. Try running dev with turbo:

turbo dev

You'll notice that your dev script starts up. You can use turbo to run any script in your package.json.