Migrate from Turborepo to Nx

If you have an existing monorepo that uses Turborepo, switching to use Nx is a straight-forward process. After switching, you'll have cleaner CLI output, a better graph view and IDE support with the option to incorporate Nx plugins and take advantage of the features of an integrated repository. All this without increasing the complexity of your configuration files.

For more details, read our comparison of Nx and Turborepo

Initialize Nx

To switch to Nx, run this command:

npx nx@latest init

The command will ask you three questions.

  1. Which scripts need to be run in order?

    Any scripts you select in this step will be set up so project dependencies will be run first. i.e. "dependsOn": "^build"

  2. Which scripts are cacheable?

    Any scripts you select in this step will be added to the cacheableOperations in nx.json. i.e. "cacheableOperations": ["build", "test", "lint"]

  3. For each cacheable script, does it produce output in the file system?

    Any folders identified will be added to the task's outputs. i.e. "outputs": ["{projectRoot}/dist"]

This process adds nx to your package.json at the root of your workspace:

1{ 2 "name": "my-workspace", 3 ... 4 "devDependencies": { 5 ... 6 "nx": "16.8.0" 7 } 8} 9

It also creates an nx.json based on the answers given during the setup process. This includes cacheable operations as well as some initial definition of the task pipeline.

Convert turbo.json into Nx Configuration

Most of the settings in your turbo.json file can be converted directly into nx.json equivalents. The key configuration properties of dependsOn, inputs and outputs have a very similar syntax and can probably be copied over directly from the turbo.json pipeline into the nx.json targetDefaults.

If you have project-specific tasks defined in the root turbo.json (i.e. myreactapp#build) or in project-level turbo.json files (i.e. /packages/myreactapp/turbo.json), those settings should go in the nx property of the project's package.json (i.e. /packages/myreactapp/package.json).

Specific configuration property conversions are documented below.


Let's say you start with the following turbo.json file:

1{ 2 "$schema": "https://turbo.build/schema.json", 3 "pipeline": { 4 "build": { 5 "dependsOn": ["^build"], 6 "outputs": ["dist/**"] 7 }, 8 "docs#build": { 9 "dependsOn": ["^build"], 10 "outputs": ["www/**"] 11 }, 12 "test": { 13 "dependsOn": ["build"], 14 "outputs": [] 15 }, 16 "e2e": { 17 "dependsOn": ["build"], 18 "outputs": [] 19 } 20 }, 21 "globalDependencies": ["babel.config.json"] 22} 23

Creating the equivalent configuration with Nx yields the following files:

1{ 2 "$schema": "./node_modules/nx/schemas/nx-schema.json", 3 "namedInputs": { 4 "sharedGlobals": ["babel.config.json"], 5 "default": ["{projectRoot}/**/*", "sharedGlobals"] 6 }, 7 "targetDefaults": { 8 "build": { 9 "dependsOn": ["^build"], 10 "inputs": ["default"], 11 "outputs": ["{projectRoot}/dist"] 12 }, 13 "test": { 14 "dependsOn": ["build"], 15 "inputs": ["default"] 16 }, 17 "e2e": { 18 "dependsOn": ["build"], 19 "inputs": ["default"] 20 } 21 }, 22 "tasksRunnerOptions": { 23 "default": { 24 "runner": "nx-cloud", 25 "options": { 26 "cacheableOperations": ["build", "e2e", "test"], 27 "accessToken": "..." 28 } 29 } 30 } 31} 32
1{ 2 "name": "docs", 3 // etc... 4 "nx": { 5 "targets": { 6 "build": { 7 "outputs": ["www/**"] 8 } 9 } 10 } 11} 12

Specific Configuration Property Conversions

For each turbo.json configuration property, the equivalent Nx property is listed.

Global Configuration:
globalDependenciesadd to the sharedGlobals namedInput
globalEnvadd to the sharedGlobals namedInput as an env input
globalPassThroughEnvN/A. See Defining Environment Variables
globalDotEnvadd to the sharedGlobals namedInput
Task Configuration:
extendsN/A. The project configurations will always extend the targetDefaults defined in nx.json.
pipeline[task].dependsOnSame syntax.
pipeline[task].dotEnvDefine file inputs
pipeline[task].envDefine env inputs
pipeline[task].passThroughEnvN/A. See Defining Environment Variables
pipeline[task].outputsSame syntax.
pipeline[task].cacheDefine in the nx.json cacheableOperations property
pipeline[task].inputsSame syntax.
pipeline[task].outputModeUse the --output-style command line flag

Command Equivalents

turbo run test lint buildnx run-many -t test lint build
--cache-dirSet in nx.json under tasksRunnerOptions.default.options.cacheDirectory
--continueUse --nx-bail with the inverse value
--cwdAvailable when using the run-commands executor
--dry-runN/A. Nx has --dry-run for nx generate but not for running tasks.
--filterUse -p admin-* or -p tag:api-*. Also see nx affected.
--graphSame syntax or nx graph for the entire graph
--forcenx reset and then run the command again
--global-depsUse inputs in the nx.json or project configuration
--framework-inferenceNx knows if you're using a particular framework if you use an executor for that framework.
--ignoreUse an .nxignore file (or .gitignore)
--log-orderUse --output-style
--no-cacheUse --skip-nx-cache
--no-daemonUse NX_DAEMON=false or set useDaemonProcess: false in nx.json
--output-logsUse --output-style
--remote-onlyN/A. Can ignore the remote cache with --no-cloud.
--tokenSet the Nx Cloud token in nx.json or as an environment variable (NX_CLOUD_ACCESS_TOKEN)
--teamSee --token for choosing a different Nx Cloud workspace. You can use --runner to choose a different runner defined in the nx.json file.
--traceN/A. --verbose for more logging.
--heapN/A. --verbose for more logging.
--cpuprofileUse NX_PROFILE=profile.json.
--verbosityUse --verbose
turbo genUse nx generate
turbo loginNo need. Use nx connect once to set up Nx Cloud.
turbo linkUse nx connect