8821b70815
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
87 lines
15 KiB
Markdown
87 lines
15 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` | 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`) |
|
|
| `--output-style` | `dynamic`, `static`, `stream`, `stream-without-prefixes`, `compact` | Defines how Nx emits outputs tasks logs. **dynamic**: use dynamic 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 on your local development environments. **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` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
|
|
| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) |
|
|
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
|
|
| `--version` | boolean | Show version number. |
|