The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.

---
title: 'create-nx-workspace - CLI command'
description: 'Create a new Nx workspace'
---

# create-nx-workspace

Create a new Nx workspace

## Usage

```bash
create-nx-workspace [name] [options]
```

Install `create-nx-workspace` globally to invoke the command directly, or use `npx create-nx-workspace`, `yarn create nx-workspace`, or `pnpx create-nx-workspace`.

## Options

### allPrompts

Type: boolean

Default: false

Show all prompts

### appName

Type: string

The name of the application when a preset with pregenerated app is selected

### ci

Type: string

Choices: [github, circleci, azure]

Generate a CI workflow file

### cli

Type: string

Choices: [nx, angular]

CLI to power the Nx workspace

### commit.email

Type: string

E-mail of the committer

### commit.message

Type: string

Default: Initial commit

Commit message

### commit.name

Type: string

Name of the committer

### defaultBase

Type: string

Default: main

Default base to use for new projects

### help

Type: boolean

Show help

### interactive

Type: boolean

Enable interactive mode with presets

### name

Type: string

Workspace name (e.g. org name)

### nxCloud

Type: boolean

Enable distributed caching to make your CI faster

### packageManager

Type: string

Choices: [npm, pnpm, yarn]

Default: npm

Package manager to use

### preset

Type: string

Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular", "angular-nest", "react", "react-express", "react-native", "expo", "next", "nest", "express"]. To build your own see https://nx.dev/packages/nx-plugin#preset

### skipGit

Type: boolean

Default: false

Skip initializing a git repository.

### style

Type: string

Style option to be used when a preset with pregenerated app is selected

### version

Type: boolean

Show version number


create-nx-workspace

---
title: 'init - CLI command'
description: 'Adds nx.json file and installs nx if not installed already'
---

# init

Adds nx.json file and installs nx if not installed already

## Usage

```bash
nx init
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.


init

---
title: 'generate - CLI command'
description: 'Runs a generator that creates and/or modifies files based on a generator from a collection.'
---

# generate

Runs a generator that creates and/or modifies files based on a generator from a collection.

## Usage

```bash
nx generate <collection:generator>
```

```bash
nx g <generator>
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Generate a new Angular application:

```bash
nx generate @nrwl/angular:app myapp
```

Generate a new React application:

```bash
nx generate @nrwl/react:app myapp
```

Generate a new web component application:

```bash
nx generate @nrwl/web:app myapp
```

Generate a new Node application:

```bash
nx generate @nrwl/node:app myapp
```

Generate a new Angular library application:

```bash
nx generate @nrwl/angular:library mylibrary
```

Generate a new React library application:

```bash
nx generate @nrwl/react:library mylibrary
```

Generate a new Node library application:

```bash
nx generate @nrwl/node:library mylibrary
```

## Options

### defaults

Default: `false`

When true, disables interactive input prompts for options with a default.

### dryRun

Default: `false`

When true, disables interactive input prompts for options with a default.

### force

Default: `false`

When true, forces overwriting of existing files.

### interactive

Default: `true`

When false, disables interactive input prompts.

### help

Show help and display available generators in the default collection.

### version

Show version number


generate

---
title: 'run - CLI command'
description: 'Runs an Architect target with an optional custom builder configuration defined in your project.'
---

# run

Runs an Architect target with an optional custom builder configuration defined in your project.

## Usage

```bash
nx run <target> [options]
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Run the `build` target for the `myapp` :

```bash
nx run myapp:build
```

Run the `build` target for the `myapp` project with a `production` configuration:

```bash
nx run myapp:build:production
```

## Options

### configuration (-c)

A named builder configuration, defined in the "configurations" section of the workspace configuration file. The builder uses the named configuration to run the given target.

### help

Show help

### version

Show version number


---
title: 'daemon - CLI command'
description: 'Prints information about the Nx Daemon process or starts a daemon process'
---

# daemon

Prints information about the Nx Daemon process or starts a daemon process

## Usage

```bash
nx daemon
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

## Options

### help

Type: boolean

Show help

### start

Type: boolean

Default: false

### stop

Type: boolean

Default: false

### version

Type: boolean

Show version number


daemon

---
title: 'graph - CLI command'
description: 'Graph dependencies within workspace'
---

# graph

Graph dependencies within workspace

## Usage

```bash
nx graph
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Open the project graph of the workspace in the browser:

```bash
nx graph
```

Save the project graph into a json file:

```bash
nx graph --file=output.json
```

Generate a static website with project graph into an html file, accompanied by an asset folder called static:

```bash
nx graph --file=output.html
```

Show the graph where every node is either an ancestor or a descendant of todos-feature-main:

```bash
nx graph --focus=todos-feature-main
```

Include project-one and project-two in the project graph:

```bash
nx graph --include=project-one,project-two
```

Exclude project-one and project-two from the project graph:

```bash
nx graph --exclude=project-one,project-two
```

Show the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two:

```bash
nx graph --focus=todos-feature-main --exclude=project-one,project-two
```

Watch for changes to project graph and update in-browser:

```bash
nx graph --watch
```

## Options

### exclude

Type: array

List of projects delimited by commas to exclude from the project graph.

### file

Type: string

Output file (e.g. --file=output.json or --file=dep-graph.html)

### focus

Type: string

Use to show the project graph for a particular project and every node that is either an ancestor or a descendant.

### groupByFolder

Type: boolean

Group projects by folder in the project graph

### help

Type: boolean

Show help

### host

Type: string

Bind the project graph server to a specific ip address.

### open

Type: boolean

Default: true

Open the project graph in the browser.

### port

Type: number

Bind the project graph server to a specific port.

### version

Type: boolean

Show version number

### watch

Type: boolean

Default: false

Watch for changes to project graph and update in-browser


graph

---
title: 'run-many - CLI command'
description: 'Run target for multiple listed projects'
---

# run-many

Run target for multiple listed projects

## Usage

```bash
nx run-many
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Test all projects:

```bash
nx run-many --target=test
```

Test proj1 and proj2:

```bash
nx run-many --target=test --projects=proj1,proj2
```

Test proj1 and proj2 in parallel:

```bash
nx run-many --target=test --projects=proj1,proj2 --parallel=2
```

## Options

### all

Type: boolean

Default: true

[deprecated] Run the target on all projects in the workspace

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### help

Type: boolean

Show help

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Only run the target on projects which previously failed

### output-style

Type: string

Choices: [dynamic, static, stream, stream-without-prefixes]

Defines how Nx emits outputs tasks logs

### parallel

Type: string

Max number of parallel processes [default is 3]

### projects

Type: string

Projects to run (comma delimited)

### runner

Type: string

Override the tasks runner in `nx.json`

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### target

Type: string

Task to run for affected projects

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


run-many

---
title: 'affected - CLI command'
description: 'Run target for affected projects'
---

# affected

Run target for affected projects

## Usage

```bash
nx affected
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Run custom target for all affected projects:

```bash
nx affected --target=custom-target
```

Run tests in parallel:

```bash
nx affected --target=test --parallel=5
```

Run the test target for all projects:

```bash
nx affected --target=test --all
```

Run tests for all the projects affected by changing the index.ts file:

```bash
nx affected --target=test --files=libs/mylib/src/index.ts
```

Run tests for all the projects affected by the changes between main and HEAD (e.g., PR):

```bash
nx affected --target=test --base=main --head=HEAD
```

Run tests for all the projects affected by the last commit on main:

```bash
nx affected --target=test --base=main~1 --head=main
```

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### output-style

Type: string

Choices: [dynamic, static, stream, stream-without-prefixes]

Defines how Nx emits outputs tasks logs

### parallel

Type: string

Max number of parallel processes [default is 3]

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### target

Type: string

Task to run for affected projects

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


affected

---
title: 'affected:graph - CLI command'
description: 'Graph dependencies affected by changes'
---

# affected:graph

Graph dependencies affected by changes

## Usage

```bash
nx affected:graph
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Open the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:

```bash
nx affected:graph --files=libs/mylib/src/index.ts
```

Open the project graph of the workspace in the browser, and highlight the projects affected by the changes between main and HEAD (e.g., PR):

```bash
nx affected:graph --base=main --head=HEAD
```

Save the project graph of the workspace in a json file, and highlight the projects affected by the changes between main and HEAD (e.g., PR):

```bash
nx affected:graph --base=main --head=HEAD --file=output.json
```

Generate a static website with project graph data in an html file, highlighting the projects affected by the changes between main and HEAD (e.g., PR):

```bash
nx affected:graph --base=main --head=HEAD --file=output.html
```

Open the project graph of the workspace in the browser, and highlight the projects affected by the last commit on main:

```bash
nx affected:graph --base=main~1 --head=main
```

Open the project graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two:

```bash
nx affected:graph --exclude=project-one,project-two
```

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### file

Type: string

Output file (e.g. --file=output.json or --file=dep-graph.html)

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### focus

Type: string

Use to show the project graph for a particular project and every node that is either an ancestor or a descendant.

### groupByFolder

Type: boolean

Group projects by folder in the project graph

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### host

Type: string

Bind the project graph server to a specific ip address.

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### open

Type: boolean

Default: true

Open the project graph in the browser.

### port

Type: number

Bind the project graph server to a specific port.

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number

### watch

Type: boolean

Default: false

Watch for changes to project graph and update in-browser


affected:graph

---
title: 'affected:apps - CLI command'
description: 'Print applications affected by changes'
---

# affected:apps

**Deprecated:** Use `nx print-affected --type=app ...` instead. This command will be removed in v15.

Print applications affected by changes

## Usage

```bash
nx affected:apps
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Print the names of all the apps affected by changing the index.ts file:

```bash
nx affected:apps --files=libs/mylib/src/index.ts
```

Print the names of all the apps affected by the changes between main and HEAD (e.g., PR):

```bash
nx affected:apps --base=main --head=HEAD
```

Print the names of all the apps affected by the last commit on main:

```bash
nx affected:apps --base=main~1 --head=main
```

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### plain

Produces a plain output for affected:apps and affected:libs

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


affected:apps

---
title: 'affected:libs - CLI command'
description: 'Print libraries affected by changes'
---

# affected:libs

**Deprecated:** Use `nx print-affected --type=lib ...` instead. This command will be removed in v15.

Print libraries affected by changes

## Usage

```bash
nx affected:libs
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Print the names of all the libs affected by changing the index.ts file:

```bash
nx affected:libs --files=libs/mylib/src/index.ts
```

Print the names of all the libs affected by the changes between main and HEAD (e.g., PR):

```bash
nx affected:libs --base=main --head=HEAD
```

Print the names of all the libs affected by the last commit on main:

```bash
nx affected:libs --base=main~1 --head=main
```

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### plain

Produces a plain output for affected:apps and affected:libs

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


affected:libs

---
title: 'print-affected - CLI command'
description: 'Prints information about the projects and targets affected by changes'
---

# print-affected

Prints information about the projects and targets affected by changes

## Usage

```bash
nx print-affected
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Print information about affected projects and the project graph:

```bash
nx print-affected
```

Print information about the projects affected by the changes between main and HEAD (e.g,. PR):

```bash
nx print-affected --base=main --head=HEAD
```

Prints information about the affected projects and a list of tasks to test them:

```bash
nx print-affected --target=test
```

Prints the projects property from the print-affected output:

```bash
nx print-affected --target=build --select=projects
```

Prints the tasks.target.project property from the print-affected output:

```bash
nx print-affected --target=build --select=tasks.target.project
```

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### select

Type: string

Select the subset of the returned json document (e.g., --select=projects)

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### type

Type: string

Choices: [app, lib]

Select the type of projects to be returned (e.g., --type=app)

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


print-affected

---
title: 'format:check - CLI command'
description: 'Check for un-formatted files'
---

# format:check

Check for un-formatted files

## Usage

```bash
nx format:check
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### libs-and-apps

Type: boolean

Format only libraries and applications files.

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### projects

Type: array

Projects to format (comma delimited)

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


format:check

---
title: 'format:write - CLI command'
description: 'Overwrite un-formatted files'
---

# format:write

Overwrite un-formatted files

## Usage

```bash
nx format:write
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

## Options

### all

Type: boolean

All projects

### base

Type: string

Base of the current branch (usually main)

### configuration

Type: string

This is the configuration to use when performing tasks on projects

### exclude

Type: array

Default: []

Exclude certain projects from being processed

### files

Type: array

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### libs-and-apps

Type: boolean

Format only libraries and applications files.

### nx-bail

Type: boolean

Default: false

Stop command execution after the first failed task

### nx-ignore-cycles

Type: boolean

Default: false

Ignore cycles in the task graph

### ~~only-failed~~

Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### projects

Type: array

Projects to format (comma delimited)

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Type: boolean

Default: false

Rerun the tasks even when the results are available in the cache

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose

Type: boolean

Default: false

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


format:write

---
title: 'migrate - CLI command'
description:
  'Creates a migrations file or runs migrations from the migrations file.
  - Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)
  - Run migrations (e.g., nx migrate --run-migrations=migrations.json)'
---

# migrate

Creates a migrations file or runs migrations from the migrations file.

- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)
- Run migrations (e.g., nx migrate --run-migrations=migrations.json)

## Usage

```bash
nx migrate [packageAndVersion]
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

Update @nrwl/workspace to "next". This will update other packages and will generate migrations.json:

```bash
nx migrate next
```

Update @nrwl/workspace to "9.0.0". This will update other packages and will generate migrations.json:

```bash
nx migrate 9.0.0
```

Update @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what installed locally:

```bash
nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0"
```

Update @nrwl/workspace to "9.0.0". If it tries to update @nrwl/react or @nrwl/angular, use version "9.0.1":

```bash
nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1"
```

Update another-package to "12.0.0". This will update other packages and will generate migrations.json file:

```bash
nx migrate another-package@12.0.0
```

Run migrations from the provided migrations.json file. You can modify migrations.json and run this command many times:

```bash
nx migrate --run-migrations=migrations.json
```

Create a dedicated commit for each successfully completed migration. You can customize the prefix used for each commit by additionally setting --commit-prefix="PREFIX_HERE ":

```bash
nx migrate --run-migrations --create-commits
```

## Options

### commitPrefix

Type: string

Default: chore: [nx migration]

Commit prefix to apply to the commit for each migration, when --create-commits is enabled

### createCommits

Type: boolean

Default: false

Automatically create a git commit after each migration runs

### from

Type: string

Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nrwl/react:12.0.0,@nrwl/js:12.0.0")

### help

Type: boolean

Show help

### packageAndVersion

Type: string

The target package and version (e.g, @nrwl/workspace@13.0.0)

### runMigrations

Type: string

Execute migrations from a file (when the file isn't provided, execute migrations from migrations.json)

### to

Type: string

Use the provided versions for packages instead of the ones calculated by the migrator (e.g., --to="@nrwl/react:12.0.0,@nrwl/js:12.0.0")

### version

Type: boolean

Show version number


migrate

---
title: 'report - CLI command'
description: 'Reports useful version numbers to copy into the Nx issue template'
---

# report

Reports useful version numbers to copy into the Nx issue template

## Usage

```bash
nx report
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.


report

---
title: 'list - CLI command'
description: 'Lists installed plugins, capabilities of installed plugins and other available plugins.'
---

# list

Lists installed plugins, capabilities of installed plugins and other available plugins.

## Usage

```bash
nx list [plugin]
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

### Examples

List the plugins installed in the current workspace:

```bash
nx list
```

List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):

```bash
nx list @nrwl/web
```

## Options

### help

Type: boolean

Show help

### plugin

Type: string

The name of an installed plugin to query

### version

Type: boolean

Show version number


list

---
title: 'workspace-lint - CLI command'
description: 'Lint nx specific workspace files (nx.json, workspace.json)'
---

# workspace-lint

Lint nx specific workspace files (nx.json, workspace.json)

## Usage

```bash
nx workspace-lint [files..]
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.


workspace-lint

---
title: 'workspace-generator - CLI command'
description: 'Runs a workspace generator from the tools/generators directory'
---

# workspace-generator

Runs a workspace generator from the tools/generators directory

## Usage

```bash
nx workspace-generator [name]
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

## Options

### help

Type: boolean

Show help

### list-generators

Type: boolean

List the available workspace-generators

### name

Type: string

The name of your generator

### version

Type: boolean

Show version number


workspace-generator

---
title: 'connect-to-nx-cloud - CLI command'
description: 'Makes sure the workspace is connected to Nx Cloud'
---

# connect-to-nx-cloud

Makes sure the workspace is connected to Nx Cloud

## Usage

```bash
nx connect-to-nx-cloud
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

## Options

### help

Type: boolean

Show help

### version

Type: boolean

Show version number


connect-to-nx-cloud

---
title: 'reset - CLI command'
description: 'Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.'
---

# reset

Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.

## Usage

```bash
nx reset
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.


reset

---
title: 'repair - CLI command'
description: 'Repair any configuration that is no longer supported by Nx.'
---

# repair

Repair any configuration that is no longer supported by Nx.

## Usage

```bash
nx repair
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

## Options

### help

Type: boolean

Show help

### verbose

Type: boolean

Prints additional information about the commands (e.g., stack traces)

### version

Type: boolean

Show version number


repair

noop

Noop

run-commands

Arguments forwarding

Custom done conditions

Setting the cwd

Extra arguments. You can pass them as follows: nx run project:target --args='--wait=100'. You can then use {args.wait} syntax to interpolate them in the workspace config file. See example [above](#chaining-commands-interpolating-args-and-setting-the-cwd)

Use colors when showing output of command.

Current working directory of the commands. If it's not specified the commands will run in the workspace root, if a relative path is specified the commands will run in that path relative to the workspace root and if it's an absolute path the commands will run in that path.

Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.

String to appear in `stdout` or `stderr` that indicates that the task is done. When running multiple commands, this option can only be used when `parallel` is set to `true`. If not specified, the task is done when all the child processes complete.

Run Commands

run-script

Run any NPM script of a project in the project's root directory.

An npm script name in the `package.json` file of the project (e.g., `build`).

nx:run-commands

Examples

Options playground

Examples

Options

unparsed

args

commands

command

color

cwd

envFile

outputPath

parallel

readyWhen

Additional Properties

nx:run-commands

Examples

Options playground

Examples

Options

__unparsed__

args

commands

command

color

cwd

envFile

outputPath

parallel

readyWhen

Additional Properties

unparsed