home / skills / nrwl / nx / nx-run-tasks

nx-run-tasks skill

/.cursor/skills/nx-run-tasks

This skill helps you run and manage Nx workspace tasks like build, test, lint, and serve across projects efficiently.

npx playbooks add skill nrwl/nx --skill nx-run-tasks

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.4 KB
---
name: nx-run-tasks
description: Helps with running tasks in an Nx workspace. USE WHEN the user wants to execute build, test, lint, serve, or run any other tasks defined in the workspace.
---

You can run tasks with Nx in the following way.

Keep in mind that you might have to prefix things with npx/pnpx/yarn if the user doesn't have nx installed globally. Look at the package.json or lockfile to determine which package manager is in use.

For more details on any command, run it with `--help` (e.g. `nx run-many --help`, `nx affected --help`).

## Understand which tasks can be run

You can check those via `nx show project <projectname> --json`, for example `nx show project myapp --json`. It contains a `targets` section which has information about targets that can be run. You can also just look at the `package.json` scripts or `project.json` targets, but you might miss out on inferred tasks by Nx plugins.

## Run a single task

```
nx run <project>:<task>
```

where `project` is the project name defined in `package.json` or `project.json` (if present).

## Run multiple tasks

```
nx run-many -t build test lint typecheck
```

You can pass a `-p` flag to filter to specific projects, otherwise it runs on all projects. You can also use `--exclude` to exclude projects, and `--parallel` to control the number of parallel processes (default is 3).

Examples:

- `nx run-many -t test -p proj1 proj2` — test specific projects
- `nx run-many -t test --projects=*-app --exclude=excluded-app` — test projects matching a pattern
- `nx run-many -t test --projects=tag:api-*` — test projects by tag

## Run tasks for affected projects

Use `nx affected` to only run tasks on projects that have been changed and projects that depend on changed projects. This is especially useful in CI and for large workspaces.

```
nx affected -t build test lint
```

By default it compares against the base branch. You can customize this:

- `nx affected -t test --base=main --head=HEAD` — compare against a specific base and head
- `nx affected -t test --files=libs/mylib/src/index.ts` — specify changed files directly

## Useful flags

These flags work with `run`, `run-many`, and `affected`:

- `--skipNxCache` — rerun tasks even when results are cached
- `--verbose` — print additional information such as stack traces
- `--nxBail` — stop execution after the first failed task
- `--configuration=<name>` — use a specific configuration (e.g. `production`)

Overview

This skill helps you run tasks in an Nx workspace reliably and efficiently. It guides which tasks exist, how to execute a single task, run many tasks in parallel, and run only affected tasks. It also recommends package manager handling and useful Nx flags for CI and local runs.

How this skill works

The skill inspects workspace metadata (project.json, package.json, and Nx inferred targets) and suggests the correct nx commands: nx run, nx run-many, and nx affected. It determines whether to prefix commands with npx/pnpm/yarn based on the repo's package manager files. It also explains key flags like --skipNxCache, --nxBail, and --configuration to tune execution.

When to use it

  • Run a single project's build, test, lint, or serve target (nx run <project>:<task>).
  • Execute the same target across many projects (nx run-many -t ...).
  • Limit work to changed projects in CI or pre-merge checks (nx affected -t ...).
  • Force reruns, get verbose logs, or stop early on failure using useful flags.
  • When you need to detect available targets with nx show project <name> --json.

Best practices

  • Check nx show project <project> --json to list available targets before running commands.
  • Use the repo's package manager prefix (npx/pnpm/yarn) if nx is not installed globally.
  • Prefer nx affected in CI to run tasks only for changed and dependent projects.
  • Use --skipNxCache sparingly; rely on Nx cache for faster repeatable runs.
  • Use --nxBail to fail fast in pipelines and --parallel to speed up run-many where safe.

Example use cases

  • Run a single app's tests: nx run myapp:test (or with npx if no global nx).
  • Test a subset of projects: nx run-many -t test -p proj1 proj2 --parallel=5.
  • CI optimization: nx affected -t build test --base=main --head=HEAD to build only changed projects.
  • Debug a failing target with verbose logs: nx run lib:build --verbose.
  • Exclude projects: nx run-many -t lint --projects=*-app --exclude=internal-app.

FAQ

How do I find what targets a project supports?

Run nx show project <projectname> --json and inspect the targets section; package.json and project.json can also help but may miss inferred targets.

Do I always need nx installed globally?

No. If nx isn't global, prefix commands with npx, pnpx, or yarn based on the repository's package manager files.