89 lines
19 KiB
Markdown
89 lines
19 KiB
Markdown
---
|
|
title: 'run - CLI command'
|
|
description: 'Run a target for a project
|
|
(e.g., nx run myapp:serve:production).
|
|
|
|
You can also use the infix notation to run a target:
|
|
(e.g., nx serve myapp --configuration=production)
|
|
|
|
You can skip the use of Nx cache by using the --skip-nx-cache option.'
|
|
---
|
|
|
|
# run
|
|
|
|
Run a target for a project
|
|
(e.g., nx run myapp:serve:production).
|
|
|
|
You can also use the infix notation to run a target:
|
|
(e.g., nx serve myapp --configuration=production)
|
|
|
|
You can skip the use of Nx cache by using the --skip-nx-cache option.
|
|
|
|
## Usage
|
|
|
|
```shell
|
|
nx run [project][:target][:configuration] [_..]
|
|
```
|
|
|
|
Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.
|
|
|
|
### Examples
|
|
|
|
Run the target build for the myapp project:
|
|
|
|
```shell
|
|
nx run myapp:build
|
|
```
|
|
|
|
Run the target build for the myapp project, with production configuration:
|
|
|
|
```shell
|
|
nx run myapp:build:production
|
|
```
|
|
|
|
Preview the task graph that Nx would run inside a webview:
|
|
|
|
```shell
|
|
nx run myapp:build --graph
|
|
```
|
|
|
|
Save the task graph to a file:
|
|
|
|
```shell
|
|
nx run myapp:build --graph=output.json
|
|
```
|
|
|
|
Print the task graph to the console:
|
|
|
|
```shell
|
|
nx run myapp:build --graph=stdout
|
|
```
|
|
|
|
Run's a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration:
|
|
|
|
```shell
|
|
nx run myapp:"build:test"
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Type | Description |
|
|
| ------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) |
|
|
| `--configuration`, `--c` | string | This is the configuration to use when performing tasks on projects. |
|
|
| `--exclude` | string | Exclude certain projects from being processed. |
|
|
| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) |
|
|
| `--graph` | string | Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. Pass "stdout" to print the results to the terminal. |
|
|
| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) |
|
|
| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) |
|
|
| `--outputStyle` | `tui`, `dynamic`, `dynamic-legacy`, `static`, `stream`, `stream-without-prefixes` | Defines how Nx emits outputs tasks logs. **tui**: enables the Nx Terminal UI, recommended for local development environments. **dynamic-legacy**: use dynamic-legacy output life cycle, previous content is overwritten or modified as new outputs are added, display minimal logs by default, always show errors. This output format is recommended for local development environments where tui is not supported. **static**: uses static output life cycle, no previous content is rewritten or modified as new outputs are added. This output format is recommened for CI environments. **stream**: nx by default logs output to an internal output stream, enable this option to stream logs to stdout / stderr. **stream-without-prefixes**: nx prefixes the project name the target is running on, use this option remove the project name prefix from output. |
|
|
| `--parallel` | string | Max number of parallel processes [default is 3]. |
|
|
| `--project` | string | Target project. |
|
|
| `--runner` | string | This is the name of the tasks runner configured in nx.json. |
|
|
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
|
|
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
|
|
| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) |
|
|
| `--tuiAutoExit` | string | Whether or not to exit the TUI automatically after all tasks finish, and after how long. If set to `true`, the TUI will exit immediately. If set to `false` the TUI will not automatically exit. If set to a number, an interruptible countdown popup will be shown for that many seconds before the TUI exits. |
|
|
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
|
|
| `--version` | boolean | Show version number. |
|