---
title: '@turbo/codemod'
description: Learn more about how Turborepo uses codemods to make version migrations easy.
---

import { Tabs, Tab } from '#components/tabs';
import { Callout } from '#components/callout';
import { Accordion, Accordions } from '#components/accordion';

Turborepo provides codemod transformations and automatic migration scripts to help upgrade your Turborepo codebase when a feature is deprecated.

Codemods are transformations that run on your codebase programmatically. This allows for a large amount of changes to be applied without having to manually manage repetitive changes.

## Usage

First, ensure that you've run your package manager's install command.

```bash title="Terminal"
npx @turbo/codemod [transform] [path] [--dry] [--print]
```

- `transform` - name of transform, see available transforms below.
- `path` - files or directory to transform
- `--dry` - Do a dry-run (Code will not be edited)
- `--print` - Prints the changed output for comparison

## Upgrading Turborepo versions

In most cases, you can run:

```bash title="Terminal"
npx @turbo/codemod
```

All the codemods you need to upgrade will be run for you.

### Turborepo 2.x

The codemods below are used for migration paths in the second major version of Turborepo.

<Accordions>

<Accordion title="update-schema-json-url (2.0.0)" id="update-schema-json-url">

Updates a versioned schema.json URL to v2.

```bash title="Terminal"
npx @turbo/codemod update-schema-json-url
```

**Example**

```diff title="./turbo.json"
{
- "$schema": "https://turborepo.com/schema.v1.json",
+ "$schema": "https://turborepo.com/schema.v2.json",
}
```

</Accordion>

<Accordion title="add-package-names (2.0.0)" id="add-package-names">

Adds a name to `package.json` in any packages that don't have one.

```bash title="Terminal"
npx @turbo/codemod add-package-names
```

**Example**

```diff title="./packages/ui/package.json"
{
+ "name": "@repo/ui",
}
```

</Accordion>

<Accordion title="clean-globs (2.0.0)" id="clean-globs">

Fix glob patterns that are invalid due to changes in processing of globs in `turbo`.

```bash title="Terminal"
npx @turbo/codemod clean-globs
```

**Example**

```diff title="./turbo.json"
{
  "tasks": {
    "build": {
      "outputs": [
        // Collapse back-to-back doublestars
-         "**/**.ext", // [!code highlight]
+         "**.ext" // [!code highlight]
        // Ensure a file extension does not have a double-star
-         "**.ext", // [!code highlight]
+         "**/*.ext" // [!code highlight]
        // Proper expansion of directory names
-         "prefix**/", // [!code highlight]
+         "prefix*/**" // [!code highlight]
      ]
    }
  }
}
```

</Accordion>

<Accordion title="migrate-dot-env (2.0.0)" id="migrate-dot-env">

Move `.env` files from the removed `dotEnv` key to `inputs`.

```bash title="Terminal"
npx @turbo/codemod migrate-dot-env
```

**Example**

```diff title="./turbo.json"
{
  "tasks": {
    "build": {
-       "dotEnv": [".env"], // [!code highlight]
      "inputs": [
        "dist/**",
+         ".env" // [!code highlight]
      ],
    }
  }
}
```

</Accordion>

<Accordion title="rename-output-mode (2.0.0)" id="rename-output-mode">

Rename the `outputMode` key to `outputLogs`.

```bash title="Terminal"
npx @turbo/codemod rename-output-mode
```

**Example**

```diff title="./turbo.json"
{
  "tasks": {
    "build": {
-     "outputMode": "errors-only" // [!code highlight]
+     "outputLogs": "errors-only" // [!code highlight]
    }
  }
}
```

</Accordion>

<Accordion title="rename-pipeline (2.0.0)" id="rename-pipeline">

Rename the `pipeline` key to `tasks`.

```bash title="Terminal"
npx @turbo/codemod rename-pipeline
```

**Example**

```diff title="./turbo.json"
{
- "pipeline": {
+ "tasks": {
    "build": {
      ...
    },
    "dev": {
      ...
    },
    "lint": {
      ...
    }
  }
}
```

</Accordion>

<Accordion title="stabilize-ui (2.0.0)" id="stabilize-ui">

Renames the `experimentalUI` key in `turbo.json` to `ui`.

```bash title="Terminal"
npx @turbo/codemod stabilize-ui
```

**Example**

```diff title="./turbo.json"
{
- "experimentalUI": true
+ "ui": true
}
```

</Accordion>
</Accordions>

### Turborepo 1.x

The codemods below are used for migration paths in the first major version of Turborepo.

<Accordions>
<Accordion title="stabilize-env-mode (1.10.0)" id="stabilize-env-mode">

Migrates `turbo.json`'s `experimentalGlobalPassThroughEnv` to `globalPassThroughEnv` and `experimentalPassThroughEnv` to `passThroughEnv`.

```bash title="Terminal"
npx @turbo/codemod stabilize-env-mode
```

**Example**

```diff title="./turbo.json"
{
  "$schema": "https://turborepo.com/schema.json",
- "experimentalGlobalPassThroughEnv": ["CC"],
+ "globalPassThroughEnv": ["CC"],
  "pipeline": {
    "build": {
-     "experimentalPassThroughEnv": ["GOROOT"],
+     "passThroughEnv": ["GOROOT"],
    }
  }
}
```

</Accordion>
<Accordion title="transform-env-literals-to-wildcards (1.10.0)" id="transform-env-literals-to-wildcards">

Updates any existing environment variable fields whose contents would be ambiguous to the new wildcard syntax.

```bash title="Terminal"
npx @turbo/codemod transform-env-literals-to-wildcards
```

**Example**

```diff title="./turbo.json"
{
  "$schema": "https://turborepo.com/schema.json",
- "globalEnv": ["THIS_*_IS_LITERAL"],
- "globalPassThroughEnv": ["!LITERAL_LEADING_EXCLAMATION"],
+  "globalEnv": ["THIS_\\*_IS_LITERAL"],
+  "globalPassThroughEnv": ["\\!LITERAL_LEADING_EXCLAMATION"],
  "pipeline": {
    "build": {
-     "env": ["50_PERCENT_OFF*_HAS_SMALL_PRINT"],
-     "passThroughEnv": ["**BOLDED**"],
+     "env": ["50_PERCENT_OFF\\*_HAS_SMALL_PRINT"],
+     "passThroughEnv": ["\\*\\*BOLDED\\*\\*"],
    }
  }
}
```

</Accordion>
<Accordion title="set-default-outputs (1.7.0)" id="set-default-outputs">

Migrates `turbo.json` outputs to include the previously inferred `dist/**` and `build/**`.

```bash title="Terminal"
npx @turbo/codemod set-default-outputs
```

**Example**

```diff title="turbo.json"
{
  "$schema": "https://turborepo.com/schema.json",
  "globalDependencies": [".env"],
  "globalEnv": ["CI_ENV"],
  "pipeline": {
    "build": {
      "dependsOn": ["^build"],
      "env": ["API_BASE"],
      "outputs": [".next/**", "!.next/cache/**"]
    },
-   "lint": {
-     "outputs": []
-    },
+   "lint": {},
    "dev": {
      "cache": false,
      "persistent": true,
+     "outputs": ["dist/**", "build/**"]
    }
  }
}

```

</Accordion>

<Accordion title="migrate-env-var-dependencies (1.5.0)" id="migrate-env-var-dependencies">

Migrates all environment variable dependencies in `turbo.json` from `dependsOn` and `globalDependencies` to `env` and `globalEnv` respectively.

```bash title="Terminal"
npx @turbo/codemod migrate-env-var-dependencies
```

**Example**

```diff title="./turbo.json"
// After, turbo.json
{
  "$schema": "https://turborepo.com/schema.json",
- "globalDependencies": [".env", "$CI_ENV"],
+ "globalDependencies": [".env"],
+ "globalEnv": ["CI_ENV"],
  "pipeline": {
    "build": {
-     "dependsOn": ["^build", "$API_BASE"],
+     "dependsOn": ["^build"],
+     "env": ["API_BASE"],
      "outputs": [".next/**", "!.next/cache/**"],
    },
    "lint": {},
    "dev": {
      "cache": false,
      "persistent": true
    }
  }
}
```

</Accordion>
<Accordion title="add-package-manager (1.1.0)" id="add-package-manager">
Transforms the root `package.json` so that `packageManager` key as the detected package manager (`yarn`, `npm`, `pnpm`) and version (e.g. `yarn@1.22.17`). This key is now [supported by Node.js](https://nodejs.org/dist/latest-v17.x/docs/api/packages.html#packagemanager) and is used by Turborepo for faster package manager detection (vs. inferring from just the filesystem alone).

```bash title="Terminal"
npx @turbo/codemod add-package-manager
```

**Example**

```diff title="./package.json"
{
  "name": "turborepo-basic",
  "version": "0.0.0",
  "private": true,
+  "packageManager": "yarn@1.22.17",
  "workspaces": [
    "apps/*",
    "packages/*"
  ]
}
```

</Accordion>

<Accordion title="create-turbo-config (1.1.0)" id="create-turbo-config">

Creates the `turbo.json` file at the root of your project based on the `"turbo"` key in `package.json`.
The `"turbo"` key is subsequently deleted from `package.json`.

```bash title="Terminal"
npx @turbo/codemod create-turbo-config
```

**Example**

<Tabs items={["package.json", "turbo.json"]}>
<Tab value="package.json">
```diff title="./package.json"
// After, package.json
{
  "name": "@acme/workspace",
  "private": true,
- "turbo": {
-   "pipeline": {
-     ...
-   }
- },
}
```
</Tab>
<Tab value="turbo.json">
```diff title="./turbo.json"
+ {
+   "$schema": "https://turborepo.com/schema.json",
+   "pipeline": {
+     ...
+   }
+ }
```
</Tab>

</Tabs>

</Accordion>
</Accordions>
