affected:graph
Graph dependencies affected by changes
Usage
nx affected:graph
Install nx
globally to invoke the command directly using nx
, or use npx nx
, yarn nx
, or pnpm nx
.
Examples
Open the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:
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
### 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