nx/docs/generated/cli/run.md
Craigory Coppola 9a556f45b8
feat(core): add --exclude-task-dependencies flag (#27137)
<!-- 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
There is no option to exclude dependent tasks when running Nx.

## Expected Behavior
There is a flag, `--exclude-task-dependencies`, to exclude task deps
from running. This is inline with other tools:

- [dotnet
cli](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build#:~:text=%2D%2Dno%2D-,dependencies,-Ignores%20project%2Dto)

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #18053
2024-07-26 13:48:50 -04:00

4.3 KiB

title description
run - CLI command 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

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:

 nx run myapp:build

Run the target build for the myapp project, with production configuration:

 nx run myapp:build:production

Preview the task graph that Nx would run inside a webview:

 nx run myapp:build --graph

Save the task graph to a file:

 nx run myapp:build --graph=output.json

Print the task graph to the console:

 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:

 nx run myapp:"build:test"

Options

batch

Type: boolean

Default: false

Run task(s) in batches for executors which support batches

configuration

Type: string

This is the configuration to use when performing tasks on projects

exclude

Type: string

Exclude certain projects from being processed

excludeTaskDependencies

Type: boolean

Default: false

Skips running dependent tasks first

graph

Type: 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

Type: boolean

Default: false

Stop command execution after the first failed task

nxIgnoreCycles

Type: boolean

Default: false

Ignore cycles in the task graph

output-style

Type: string

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

Defines how Nx emits outputs tasks logs

option description
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

Type: string

Max number of parallel processes [default is 3]

project

Type: string

Target project

runner

Type: string

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

skipNxCache

Type: boolean

Default: false

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

verbose

Type: boolean

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

version

Type: boolean

Show version number