miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

docs(core): update format docs generation (#12880)

Browse Source
This commit is contained in:
Benjamin Cabanes 2022-10-28 10:54:05 -04:00 committed by GitHub
parent 758956d13d
commit ea40631999
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 352 additions and 574 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/generated/cli/affected-apps.md
View File

@ -21,124 +21,103 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Print the names of all the apps affected by changing the index.ts file: Print the names of all the apps affected by changing the index.ts file:
```bash ````bash
nx affected:apps --files=libs/mylib/src/index.ts nx affected:apps --files=libs/mylib/src/index.ts```
```
Print the names of all the apps affected by the changes between main and HEAD (e.g., PR): Print the names of all the apps affected by the changes between main and HEAD (e.g., PR):
```bash ```bash
nx affected:apps --base=main --head=HEAD nx affected:apps --base=main --head=HEAD```
```
Print the names of all the apps affected by the last commit on main: Print the names of all the apps affected by the last commit on main:
```bash ```bash
nx affected:apps --base=main~1 --head=main nx affected:apps --base=main~1 --head=main```
```
## Options ## Options
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### plain ### plain
Produces a plain output for affected:apps and affected:libs Produces a plain output for affected:apps and affected:libs
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

110
docs/generated/cli/affected-graph.md
View File

@ -19,184 +19,148 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Open the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file: Open the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:
```bash ````bash
nx affected:graph --files=libs/mylib/src/index.ts 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): 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 ```bash
nx affected:graph --base=main --head=HEAD 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): 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 ```bash
nx affected:graph --base=main --head=HEAD --file=output.json 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): 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 ```bash
nx affected:graph --base=main --head=HEAD --file=output.html 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: Open the project graph of the workspace in the browser, and highlight the projects affected by the last commit on main:
```bash ```bash
nx affected:graph --base=main~1 --head=main 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: Open the project graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two:
```bash ```bash
nx affected:graph --exclude=project-one,project-two nx affected:graph --exclude=project-one,project-two```
```
## Options ## Options
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### file ### file
Type: string Type: `string`
Output file (e.g. --file=output.json or --file=dep-graph.html) Output file (e.g. --file=output.json or --file=dep-graph.html)
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### focus ### focus
Type: string Type: `string`
Use to show the project graph for a particular project and every node that is either an ancestor or a descendant. Use to show the project graph for a particular project and every node that is either an ancestor or a descendant.
### groupByFolder ### groupByFolder
Type: boolean Type: `boolean`
Group projects by folder in the project graph Group projects by folder in the project graph
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### host ### host
Type: string Type: `string`
Bind the project graph server to a specific ip address. Bind the project graph server to a specific ip address.
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### open ### open
Type: boolean Type: `boolean`
Default: true Default: `true`
Open the project graph in the browser. Open the project graph in the browser.
### port ### port
Type: number Type: `number`
Bind the project graph server to a specific port. Bind the project graph server to a specific port.
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
### watch ### watch
Type: boolean Type: `boolean`
Default: false Default: `false`
Watch for changes to project graph and update in-browser Watch for changes to project graph and update in-browser
````

71
docs/generated/cli/affected-libs.md
View File

@ -21,124 +21,103 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Print the names of all the libs affected by changing the index.ts file: Print the names of all the libs affected by changing the index.ts file:
```bash ````bash
nx affected:libs --files=libs/mylib/src/index.ts nx affected:libs --files=libs/mylib/src/index.ts```
```
Print the names of all the libs affected by the changes between main and HEAD (e.g., PR): Print the names of all the libs affected by the changes between main and HEAD (e.g., PR):
```bash ```bash
nx affected:libs --base=main --head=HEAD nx affected:libs --base=main --head=HEAD```
```
Print the names of all the libs affected by the last commit on main: Print the names of all the libs affected by the last commit on main:
```bash ```bash
nx affected:libs --base=main~1 --head=main nx affected:libs --base=main~1 --head=main```
```
## Options ## Options
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### plain ### plain
Produces a plain output for affected:apps and affected:libs Produces a plain output for affected:apps and affected:libs
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

94
docs/generated/cli/affected.md
View File

@ -19,158 +19,126 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Run custom target for all affected projects: Run custom target for all affected projects:
```bash ````bash
nx affected --target=custom-target nx affected --target=custom-target```
```
Run tests in parallel: Run tests in parallel:
```bash ```bash
nx affected --target=test --parallel=5 nx affected --target=test --parallel=5```
```
Run the test target for all projects: Run the test target for all projects:
```bash ```bash
nx affected --target=test --all nx affected --target=test --all```
```
Run tests for all the projects affected by changing the index.ts file: Run tests for all the projects affected by changing the index.ts file:
```bash ```bash
nx affected --target=test --files=libs/mylib/src/index.ts nx affected --target=test --files=libs/mylib/src/index.ts```
```
Run tests for all the projects affected by the changes between main and HEAD (e.g., PR): Run tests for all the projects affected by the changes between main and HEAD (e.g., PR):
```bash ```bash
nx affected --target=test --base=main --head=HEAD nx affected --target=test --base=main --head=HEAD```
```
Run tests for all the projects affected by the last commit on main: Run tests for all the projects affected by the last commit on main:
```bash ```bash
nx affected --target=test --base=main~1 --head=main nx affected --target=test --base=main~1 --head=main```
```
## Options ## Options
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### output-style ### output-style
Type: string Type: `string`
Choices: [dynamic, static, stream, stream-without-prefixes] Choices: [dynamic, static, stream, stream-without-prefixes]
Defines how Nx emits outputs tasks logs Defines how Nx emits outputs tasks logs
### parallel ### parallel
Type: string Type: `string`
Max number of parallel processes [default is 3] Max number of parallel processes [default is 3]
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### target ### target
Type: string Type: `string`
Task to run for affected projects Task to run for affected projects
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

4
docs/generated/cli/connect-to-nx-cloud.md
View File

@ -19,12 +19,12 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

44
docs/generated/cli/create-nx-workspace.md
View File

@ -19,21 +19,21 @@ Install `create-nx-workspace` globally to invoke the command directly, or use `n
### allPrompts ### allPrompts
Type: boolean Type: `boolean`
Default: false Default: `false`
Show all prompts Show all prompts
### appName ### appName
Type: string Type: `string`
The name of the application when a preset with pregenerated app is selected The name of the application when a preset with pregenerated app is selected
### ci ### ci
Type: string Type: `string`
Choices: [github, circleci, azure] Choices: [github, circleci, azure]
@ -41,7 +41,7 @@ Generate a CI workflow file
### cli ### cli
Type: string Type: `string`
Choices: [nx, angular] Choices: [nx, angular]
@ -49,88 +49,88 @@ CLI to power the Nx workspace
### commit.email ### commit.email
Type: string Type: `string`
E-mail of the committer E-mail of the committer
### commit.message ### commit.message
Type: string Type: `string`
Default: Initial commit Default: `Initial commit`
Commit message Commit message
### commit.name ### commit.name
Type: string Type: `string`
Name of the committer Name of the committer
### defaultBase ### defaultBase
Type: string Type: `string`
Default: main Default: `main`
Default base to use for new projects Default base to use for new projects
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### interactive ### interactive
Type: boolean Type: `boolean`
Enable interactive mode with presets Enable interactive mode with presets
### name ### name
Type: string Type: `string`
Workspace name (e.g. org name) Workspace name (e.g. org name)
### nxCloud ### nxCloud
Type: boolean Type: `boolean`
Enable distributed caching to make your CI faster Enable distributed caching to make your CI faster
### packageManager ### packageManager
Type: string Type: `string`
Choices: [npm, pnpm, yarn] Choices: [npm, pnpm, yarn]
Default: npm Default: `npm`
Package manager to use Package manager to use
### preset ### preset
Type: string Type: `string`
Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular", "angular-nest", "react", "react-express", "react-native", "expo", "next", "nest", "express"]. To build your own see https://nx.dev/packages/nx-plugin#preset Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular", "angular-nest", "react", "react-express", "react-native", "expo", "next", "nest", "express"]. To build your own see https://nx.dev/packages/nx-plugin#preset
### skipGit ### skipGit
Type: boolean Type: `boolean`
Default: false Default: `false`
Skip initializing a git repository. Skip initializing a git repository.
### style ### style
Type: string Type: `string`
Style option to be used when a preset with pregenerated app is selected Style option to be used when a preset with pregenerated app is selected
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

12
docs/generated/cli/daemon.md
View File

@ -19,24 +19,24 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### start ### start
Type: boolean Type: `boolean`
Default: false Default: `false`
### stop ### stop
Type: boolean Type: `boolean`
Default: false Default: `false`
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

44
docs/generated/cli/format-check.md
View File

@ -19,112 +19,112 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### libs-and-apps ### libs-and-apps
Type: boolean Type: `boolean`
Format only libraries and applications files. Format only libraries and applications files.
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### projects ### projects
Type: array Type: `array`
Projects to format (comma delimited) Projects to format (comma delimited)
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

44
docs/generated/cli/format-write.md
View File

@ -19,112 +19,112 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### libs-and-apps ### libs-and-apps
Type: boolean Type: `boolean`
Format only libraries and applications files. Format only libraries and applications files.
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### projects ### projects
Type: array Type: `array`
Projects to format (comma delimited) Projects to format (comma delimited)
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

74
docs/generated/cli/graph.md
View File

@ -19,114 +19,84 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Open the project graph of the workspace in the browser: Open the project graph of the workspace in the browser:
```bash ````bash
nx graph nx graph```
```
Save the project graph into a json file: Save the project graph into a json file:
```bash ```bash
nx graph --file=output.json nx graph --file=output.json```
```
Generate a static website with project graph into an html file, accompanied by an asset folder called static: Generate a static website with project graph into an html file, accompanied by an asset folder called static:
```bash ```bash
nx graph --file=output.html nx graph --file=output.html```
```
Show the graph where every node is either an ancestor or a descendant of todos-feature-main: Show the graph where every node is either an ancestor or a descendant of todos-feature-main:
```bash ```bash
nx graph --focus=todos-feature-main nx graph --focus=todos-feature-main```
```
Include project-one and project-two in the project graph: Include project-one and project-two in the project graph:
```bash ```bash
nx graph --include=project-one,project-two nx graph --include=project-one,project-two```
```
Exclude project-one and project-two from the project graph: Exclude project-one and project-two from the project graph:
```bash ```bash
nx graph --exclude=project-one,project-two nx graph --exclude=project-one,project-two```
```
Show the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two: Show the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two:
```bash ```bash
nx graph --focus=todos-feature-main --exclude=project-one,project-two nx graph --focus=todos-feature-main --exclude=project-one,project-two```
```
Watch for changes to project graph and update in-browser: Watch for changes to project graph and update in-browser:
```bash ```bash
nx graph --watch nx graph --watch```
```
## Options ## Options
### exclude ### exclude
Type: array Type: `array`
List of projects delimited by commas to exclude from the project graph. List of projects delimited by commas to exclude from the project graph.
### file ### file
Type: string Type: `string`
Output file (e.g. --file=output.json or --file=dep-graph.html) Output file (e.g. --file=output.json or --file=dep-graph.html)
### focus ### focus
Type: string Type: `string`
Use to show the project graph for a particular project and every node that is either an ancestor or a descendant. Use to show the project graph for a particular project and every node that is either an ancestor or a descendant.
### groupByFolder ### groupByFolder
Type: boolean Type: `boolean`
Group projects by folder in the project graph Group projects by folder in the project graph
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### host ### host
Type: string Type: `string`
Bind the project graph server to a specific ip address. Bind the project graph server to a specific ip address.
### open ### open
Type: boolean Type: `boolean`
Default: true Default: `true`
Open the project graph in the browser. Open the project graph in the browser.
### port ### port
Type: number Type: `number`
Bind the project graph server to a specific port. Bind the project graph server to a specific port.
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
### watch ### watch
Type: boolean Type: `boolean`
Default: false Default: `false`
Watch for changes to project graph and update in-browser Watch for changes to project graph and update in-browser
````

19
docs/generated/cli/list.md
View File

@ -19,32 +19,27 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
List the plugins installed in the current workspace: List the plugins installed in the current workspace:
```bash ````bash
nx list nx list```
```
List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace): List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
```bash ```bash
nx list @nrwl/web nx list @nrwl/web```
```
## Options ## Options
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### plugin ### plugin
Type: string Type: `string`
The name of an installed plugin to query The name of an installed plugin to query
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

63
docs/generated/cli/migrate.md
View File

@ -25,96 +25,71 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Update @nrwl/workspace to "next". This will update other packages and will generate migrations.json: Update @nrwl/workspace to "next". This will update other packages and will generate migrations.json:
```bash ````bash
nx migrate next nx migrate next```
```
Update @nrwl/workspace to "9.0.0". This will update other packages and will generate migrations.json: Update @nrwl/workspace to "9.0.0". This will update other packages and will generate migrations.json:
```bash ```bash
nx migrate 9.0.0 nx migrate 9.0.0```
```
Update @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what installed locally: Update @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what installed locally:
```bash ```bash
nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0" nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0"```
```
Update @nrwl/workspace to "9.0.0". If it tries to update @nrwl/react or @nrwl/angular, use version "9.0.1": Update @nrwl/workspace to "9.0.0". If it tries to update @nrwl/react or @nrwl/angular, use version "9.0.1":
```bash ```bash
nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1" nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1"```
```
Update another-package to "12.0.0". This will update other packages and will generate migrations.json file: Update another-package to "12.0.0". This will update other packages and will generate migrations.json file:
```bash ```bash
nx migrate another-package@12.0.0 nx migrate another-package@12.0.0```
```
Run migrations from the provided migrations.json file. You can modify migrations.json and run this command many times: Run migrations from the provided migrations.json file. You can modify migrations.json and run this command many times:
```bash ```bash
nx migrate --run-migrations=migrations.json nx migrate --run-migrations=migrations.json```
```
Create a dedicated commit for each successfully completed migration. You can customize the prefix used for each commit by additionally setting --commit-prefix="PREFIX_HERE ": Create a dedicated commit for each successfully completed migration. You can customize the prefix used for each commit by additionally setting --commit-prefix="PREFIX_HERE ":
```bash ```bash
nx migrate --run-migrations --create-commits nx migrate --run-migrations --create-commits```
```
## Options ## Options
### commitPrefix ### commitPrefix
Type: string Type: `string`
Default: chore: [nx migration] Default: `chore: [nx migration] `
Commit prefix to apply to the commit for each migration, when --create-commits is enabled Commit prefix to apply to the commit for each migration, when --create-commits is enabled
### createCommits ### createCommits
Type: boolean Type: `boolean`
Default: false Default: `false`
Automatically create a git commit after each migration runs Automatically create a git commit after each migration runs
### from ### from
Type: string Type: `string`
Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nrwl/react:12.0.0,@nrwl/js:12.0.0") Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nrwl/react:12.0.0,@nrwl/js:12.0.0")
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### packageAndVersion ### packageAndVersion
Type: string Type: `string`
The target package and version (e.g, @nrwl/workspace@13.0.0) The target package and version (e.g, @nrwl/workspace@13.0.0)
### runMigrations ### runMigrations
Type: string Type: `string`
Execute migrations from a file (when the file isn't provided, execute migrations from migrations.json) Execute migrations from a file (when the file isn't provided, execute migrations from migrations.json)
### to ### to
Type: string Type: `string`
Use the provided versions for packages instead of the ones calculated by the migrator (e.g., --to="@nrwl/react:12.0.0,@nrwl/js:12.0.0") Use the provided versions for packages instead of the ones calculated by the migrator (e.g., --to="@nrwl/react:12.0.0,@nrwl/js:12.0.0")
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

86
docs/generated/cli/print-affected.md
View File

@ -19,146 +19,118 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Print information about affected projects and the project graph: Print information about affected projects and the project graph:
```bash ````bash
nx print-affected nx print-affected```
```
Print information about the projects affected by the changes between main and HEAD (e.g,. PR): Print information about the projects affected by the changes between main and HEAD (e.g,. PR):
```bash ```bash
nx print-affected --base=main --head=HEAD nx print-affected --base=main --head=HEAD```
```
Prints information about the affected projects and a list of tasks to test them: Prints information about the affected projects and a list of tasks to test them:
```bash ```bash
nx print-affected --target=test nx print-affected --target=test```
```
Prints the projects property from the print-affected output: Prints the projects property from the print-affected output:
```bash ```bash
nx print-affected --target=build --select=projects nx print-affected --target=build --select=projects```
```
Prints the tasks.target.project property from the print-affected output: Prints the tasks.target.project property from the print-affected output:
```bash ```bash
nx print-affected --target=build --select=tasks.target.project nx print-affected --target=build --select=tasks.target.project```
```
## Options ## Options
### all ### all
Type: boolean Type: `boolean`
All projects All projects
### base ### base
Type: string Type: `string`
Base of the current branch (usually main) Base of the current branch (usually main)
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### files ### files
Type: array Type: `array`
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head ### head
Type: string Type: `string`
Latest commit of the current branch (usually HEAD) Latest commit of the current branch (usually HEAD)
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### runner ### runner
Type: string Type: `string`
This is the name of the tasks runner configured in nx.json This is the name of the tasks runner configured in nx.json
### select ### select
Type: string Type: `string`
Select the subset of the returned json document (e.g., --select=projects) Select the subset of the returned json document (e.g., --select=projects)
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### type ### type
Type: string Type: `string`
Choices: [app, lib] Choices: [app, lib]
Select the type of projects to be returned (e.g., --type=app) Select the type of projects to be returned (e.g., --type=app)
### uncommitted ### uncommitted
Type: boolean Type: `boolean`
Uncommitted changes Uncommitted changes
### untracked ### untracked
Type: boolean Type: `boolean`
Untracked changes Untracked changes
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

6
docs/generated/cli/repair.md
View File

@ -19,18 +19,18 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### verbose ### verbose
Type: boolean Type: `boolean`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

69
docs/generated/cli/run-many.md
View File

@ -19,118 +19,99 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Test all projects: Test all projects:
```bash ````bash
nx run-many --target=test nx run-many --target=test```
```
Test proj1 and proj2: Test proj1 and proj2:
```bash ```bash
nx run-many --target=test --projects=proj1,proj2 nx run-many --target=test --projects=proj1,proj2```
```
Test proj1 and proj2 in parallel: Test proj1 and proj2 in parallel:
```bash ```bash
nx run-many --target=test --projects=proj1,proj2 --parallel=2 nx run-many --target=test --projects=proj1,proj2 --parallel=2```
```
## Options ## Options
### all ### all
Type: boolean Type: `boolean`
Default: true Default: `true`
[deprecated] Run the target on all projects in the workspace [deprecated] Run the target on all projects in the workspace
### configuration ### configuration
Type: string Type: `string`
This is the configuration to use when performing tasks on projects This is the configuration to use when performing tasks on projects
### exclude ### exclude
Type: array Type: `array`
Default: [] Default: `[]`
Exclude certain projects from being processed Exclude certain projects from being processed
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### nx-bail ### nx-bail
Type: boolean Type: `boolean`
Default: false Default: `false`
Stop command execution after the first failed task Stop command execution after the first failed task
### nx-ignore-cycles ### nx-ignore-cycles
Type: boolean Type: `boolean`
Default: false Default: `false`
Ignore cycles in the task graph Ignore cycles in the task graph
### output-style ### output-style
Type: string Type: `string`
Choices: [dynamic, static, stream, stream-without-prefixes] Choices: [dynamic, static, stream, stream-without-prefixes]
Defines how Nx emits outputs tasks logs Defines how Nx emits outputs tasks logs
### parallel ### parallel
Type: string Type: `string`
Max number of parallel processes [default is 3] Max number of parallel processes [default is 3]
### projects ### projects
Type: string Type: `string`
Projects to run (comma delimited) Projects to run (comma delimited)
### runner ### runner
Type: string Type: `string`
Override the tasks runner in `nx.json` Override the tasks runner in `nx.json`
### skip-nx-cache ### skip-nx-cache
Type: boolean Type: `boolean`
Default: false Default: `false`
Rerun the tasks even when the results are available in the cache Rerun the tasks even when the results are available in the cache
### target ### target
Type: string Type: `string`
Task to run for affected projects Task to run for affected projects
### verbose ### verbose
Type: boolean Type: `boolean`
Default: false Default: `false`
Prints additional information about the commands (e.g., stack traces) Prints additional information about the commands (e.g., stack traces)
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number
````

8
docs/generated/cli/workspace-generator.md
View File

@ -19,24 +19,24 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
### help ### help
Type: boolean Type: `boolean`
Show help Show help
### list-generators ### list-generators
Type: boolean Type: `boolean`
List the available workspace-generators List the available workspace-generators
### name ### name
Type: string Type: `string`
The name of your generator The name of your generator
### version ### version
Type: boolean Type: `boolean`
Show version number Show version number

32
docs/generated/packages/nx.json
View File

@ -10,7 +10,7 @@
"name": "create-nx-workspace", "name": "create-nx-workspace",
"id": "create-nx-workspace", "id": "create-nx-workspace",
"file": "generated/cli/create-nx-workspace", "file": "generated/cli/create-nx-workspace",
"content": "---\ntitle: 'create-nx-workspace - CLI command'\ndescription: 'Create a new Nx workspace'\n---\n\n# create-nx-workspace\n\nCreate a new Nx workspace\n\n## Usage\n\n```bash\ncreate-nx-workspace [name] [options]\n```\n\nInstall `create-nx-workspace` globally to invoke the command directly, or use `npx create-nx-workspace`, `yarn create nx-workspace`, or `pnpx create-nx-workspace`.\n\n## Options\n\n### allPrompts\n\nType: boolean\n\nDefault: false\n\nShow all prompts\n\n### appName\n\nType: string\n\nThe name of the application when a preset with pregenerated app is selected\n\n### ci\n\nType: string\n\nChoices: [github, circleci, azure]\n\nGenerate a CI workflow file\n\n### cli\n\nType: string\n\nChoices: [nx, angular]\n\nCLI to power the Nx workspace\n\n### commit.email\n\nType: string\n\nE-mail of the committer\n\n### commit.message\n\nType: string\n\nDefault: Initial commit\n\nCommit message\n\n### commit.name\n\nType: string\n\nName of the committer\n\n### defaultBase\n\nType: string\n\nDefault: main\n\nDefault base to use for new projects\n\n### help\n\nType: boolean\n\nShow help\n\n### interactive\n\nType: boolean\n\nEnable interactive mode with presets\n\n### name\n\nType: string\n\nWorkspace name (e.g. org name)\n\n### nxCloud\n\nType: boolean\n\nEnable distributed caching to make your CI faster\n\n### packageManager\n\nType: string\n\nChoices: [npm, pnpm, yarn]\n\nDefault: npm\n\nPackage manager to use\n\n### preset\n\nType: string\n\nCustomizes the initial content of your workspace. Default presets include: [\"apps\", \"empty\", \"core\", \"npm\", \"ts\", \"web-components\", \"angular\", \"angular-nest\", \"react\", \"react-express\", \"react-native\", \"expo\", \"next\", \"nest\", \"express\"]. To build your own see https://nx.dev/packages/nx-plugin#preset\n\n### skipGit\n\nType: boolean\n\nDefault: false\n\nSkip initializing a git repository.\n\n### style\n\nType: string\n\nStyle option to be used when a preset with pregenerated app is selected\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'create-nx-workspace - CLI command'\ndescription: 'Create a new Nx workspace'\n---\n\n# create-nx-workspace\n\nCreate a new Nx workspace\n\n## Usage\n\n```bash\ncreate-nx-workspace [name] [options]\n```\n\nInstall `create-nx-workspace` globally to invoke the command directly, or use `npx create-nx-workspace`, `yarn create nx-workspace`, or `pnpx create-nx-workspace`.\n\n## Options\n\n### allPrompts\n\nType: `boolean`\n\nDefault: `false`\n\nShow all prompts\n\n### appName\n\nType: `string`\n\nThe name of the application when a preset with pregenerated app is selected\n\n### ci\n\nType: `string`\n\nChoices: [github, circleci, azure]\n\nGenerate a CI workflow file\n\n### cli\n\nType: `string`\n\nChoices: [nx, angular]\n\nCLI to power the Nx workspace\n\n### commit.email\n\nType: `string`\n\nE-mail of the committer\n\n### commit.message\n\nType: `string`\n\nDefault: `Initial commit`\n\nCommit message\n\n### commit.name\n\nType: `string`\n\nName of the committer\n\n### defaultBase\n\nType: `string`\n\nDefault: `main`\n\nDefault base to use for new projects\n\n### help\n\nType: `boolean`\n\nShow help\n\n### interactive\n\nType: `boolean`\n\nEnable interactive mode with presets\n\n### name\n\nType: `string`\n\nWorkspace name (e.g. org name)\n\n### nxCloud\n\nType: `boolean`\n\nEnable distributed caching to make your CI faster\n\n### packageManager\n\nType: `string`\n\nChoices: [npm, pnpm, yarn]\n\nDefault: `npm`\n\nPackage manager to use\n\n### preset\n\nType: `string`\n\nCustomizes the initial content of your workspace. Default presets include: [\"apps\", \"empty\", \"core\", \"npm\", \"ts\", \"web-components\", \"angular\", \"angular-nest\", \"react\", \"react-express\", \"react-native\", \"expo\", \"next\", \"nest\", \"express\"]. To build your own see https://nx.dev/packages/nx-plugin#preset\n\n### skipGit\n\nType: `boolean`\n\nDefault: `false`\n\nSkip initializing a git repository.\n\n### style\n\nType: `string`\n\nStyle option to be used when a preset with pregenerated app is selected\n\n### version\n\nType: `boolean`\n\nShow version number\n"
}, },
{ {
"name": "init", "name": "init",
@ -36,73 +36,73 @@
"name": "daemon", "name": "daemon",
"id": "daemon", "id": "daemon",
"file": "generated/cli/daemon", "file": "generated/cli/daemon",
"content": "---\ntitle: 'daemon - CLI command'\ndescription: 'Prints information about the Nx Daemon process or starts a daemon process'\n---\n\n# daemon\n\nPrints information about the Nx Daemon process or starts a daemon process\n\n## Usage\n\n```bash\nnx daemon\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: boolean\n\nShow help\n\n### start\n\nType: boolean\n\nDefault: false\n\n### stop\n\nType: boolean\n\nDefault: false\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'daemon - CLI command'\ndescription: 'Prints information about the Nx Daemon process or starts a daemon process'\n---\n\n# daemon\n\nPrints information about the Nx Daemon process or starts a daemon process\n\n## Usage\n\n```bash\nnx daemon\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: `boolean`\n\nShow help\n\n### start\n\nType: `boolean`\n\nDefault: `false`\n\n### stop\n\nType: `boolean`\n\nDefault: `false`\n\n### version\n\nType: `boolean`\n\nShow version number\n"
}, },
{ {
"name": "graph", "name": "graph",
"id": "dep-graph", "id": "dep-graph",
"tags": ["explore-graph"], "tags": ["explore-graph"],
"file": "generated/cli/graph", "file": "generated/cli/graph",
"content": "---\ntitle: 'graph - CLI command'\ndescription: 'Graph dependencies within workspace'\n---\n\n# graph\n\nGraph dependencies within workspace\n\n## Usage\n\n```bash\nnx graph\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nOpen the project graph of the workspace in the browser:\n\n```bash\nnx graph\n```\n\nSave the project graph into a json file:\n\n```bash\nnx graph --file=output.json\n```\n\nGenerate a static website with project graph into an html file, accompanied by an asset folder called static:\n\n```bash\nnx graph --file=output.html\n```\n\nShow the graph where every node is either an ancestor or a descendant of todos-feature-main:\n\n```bash\nnx graph --focus=todos-feature-main\n```\n\nInclude project-one and project-two in the project graph:\n\n```bash\nnx graph --include=project-one,project-two\n```\n\nExclude project-one and project-two from the project graph:\n\n```bash\nnx graph --exclude=project-one,project-two\n```\n\nShow the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two:\n\n```bash\nnx graph --focus=todos-feature-main --exclude=project-one,project-two\n```\n\nWatch for changes to project graph and update in-browser:\n\n```bash\nnx graph --watch\n```\n\n## Options\n\n### exclude\n\nType: array\n\nList of projects delimited by commas to exclude from the project graph.\n\n### file\n\nType: string\n\nOutput file (e.g. --file=output.json or --file=dep-graph.html)\n\n### focus\n\nType: string\n\nUse to show the project graph for a particular project and every node that is either an ancestor or a descendant.\n\n### groupByFolder\n\nType: boolean\n\nGroup projects by folder in the project graph\n\n### help\n\nType: boolean\n\nShow help\n\n### host\n\nType: string\n\nBind the project graph server to a specific ip address.\n\n### open\n\nType: boolean\n\nDefault: true\n\nOpen the project graph in the browser.\n\n### port\n\nType: number\n\nBind the project graph server to a specific port.\n\n### version\n\nType: boolean\n\nShow version number\n\n### watch\n\nType: boolean\n\nDefault: false\n\nWatch for changes to project graph and update in-browser\n" "content": "---\ntitle: 'graph - CLI command'\ndescription: 'Graph dependencies within workspace'\n---\n\n# graph\n\nGraph dependencies within workspace\n\n## Usage\n\n```bash\nnx graph\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nOpen the project graph of the workspace in the browser:\n\n````bash\n nx graph```\nSave the project graph into a json file:\n```bash\n nx graph --file=output.json```\nGenerate a static website with project graph into an html file, accompanied by an asset folder called static:\n```bash\n nx graph --file=output.html```\nShow the graph where every node is either an ancestor or a descendant of todos-feature-main:\n```bash\n nx graph --focus=todos-feature-main```\nInclude project-one and project-two in the project graph:\n```bash\n nx graph --include=project-one,project-two```\nExclude project-one and project-two from the project graph:\n```bash\n nx graph --exclude=project-one,project-two```\nShow the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two:\n```bash\n nx graph --focus=todos-feature-main --exclude=project-one,project-two```\nWatch for changes to project graph and update in-browser:\n```bash\n nx graph --watch```\n\n## Options\n\n### exclude\n\nType: `array`\n\nList of projects delimited by commas to exclude from the project graph.\n### file\n\nType: `string`\n\nOutput file (e.g. --file=output.json or --file=dep-graph.html)\n### focus\n\nType: `string`\n\nUse to show the project graph for a particular project and every node that is either an ancestor or a descendant.\n### groupByFolder\n\nType: `boolean`\n\nGroup projects by folder in the project graph\n### help\n\nType: `boolean`\n\nShow help\n### host\n\nType: `string`\n\nBind the project graph server to a specific ip address.\n### open\n\nType: `boolean`\n\nDefault: `true`\n\nOpen the project graph in the browser.\n### port\n\nType: `number`\n\nBind the project graph server to a specific port.\n### version\n\nType: `boolean`\n\nShow version number\n### watch\n\nType: `boolean`\n\nDefault: `false`\n\nWatch for changes to project graph and update in-browser\n````\n"
}, },
{ {
"name": "run-many", "name": "run-many",
"tags": ["run-tasks", "use-task-executors"], "tags": ["run-tasks", "use-task-executors"],
"id": "run-many", "id": "run-many",
"file": "generated/cli/run-many", "file": "generated/cli/run-many",
"content": "---\ntitle: 'run-many - CLI command'\ndescription: 'Run target for multiple listed projects'\n---\n\n# run-many\n\nRun target for multiple listed projects\n\n## Usage\n\n```bash\nnx run-many\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nTest all projects:\n\n```bash\nnx run-many --target=test\n```\n\nTest proj1 and proj2:\n\n```bash\nnx run-many --target=test --projects=proj1,proj2\n```\n\nTest proj1 and proj2 in parallel:\n\n```bash\nnx run-many --target=test --projects=proj1,proj2 --parallel=2\n```\n\n## Options\n\n### all\n\nType: boolean\n\nDefault: true\n\n[deprecated] Run the target on all projects in the workspace\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### help\n\nType: boolean\n\nShow help\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### output-style\n\nType: string\n\nChoices: [dynamic, static, stream, stream-without-prefixes]\n\nDefines how Nx emits outputs tasks logs\n\n### parallel\n\nType: string\n\nMax number of parallel processes [default is 3]\n\n### projects\n\nType: string\n\nProjects to run (comma delimited)\n\n### runner\n\nType: string\n\nOverride the tasks runner in `nx.json`\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### target\n\nType: string\n\nTask to run for affected projects\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'run-many - CLI command'\ndescription: 'Run target for multiple listed projects'\n---\n\n# run-many\n\nRun target for multiple listed projects\n\n## Usage\n\n```bash\nnx run-many\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nTest all projects:\n\n````bash\n nx run-many --target=test```\nTest proj1 and proj2:\n```bash\n nx run-many --target=test --projects=proj1,proj2```\nTest proj1 and proj2 in parallel:\n```bash\n nx run-many --target=test --projects=proj1,proj2 --parallel=2```\n\n## Options\n\n### all\n\nType: `boolean`\n\nDefault: `true`\n\n[deprecated] Run the target on all projects in the workspace\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n### help\n\nType: `boolean`\n\nShow help\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n### output-style\n\nType: `string`\n\nChoices: [dynamic, static, stream, stream-without-prefixes]\n\nDefines how Nx emits outputs tasks logs\n### parallel\n\nType: `string`\n\nMax number of parallel processes [default is 3]\n### projects\n\nType: `string`\n\nProjects to run (comma delimited)\n### runner\n\nType: `string`\n\nOverride the tasks runner in `nx.json`\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n### target\n\nType: `string`\n\nTask to run for affected projects\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "affected", "name": "affected",
"tags": ["run-tasks", "use-task-executors"], "tags": ["run-tasks", "use-task-executors"],
"id": "affected", "id": "affected",
"file": "generated/cli/affected", "file": "generated/cli/affected",
"content": "---\ntitle: 'affected - CLI command'\ndescription: 'Run target for affected projects'\n---\n\n# affected\n\nRun target for affected projects\n\n## Usage\n\n```bash\nnx affected\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nRun custom target for all affected projects:\n\n```bash\nnx affected --target=custom-target\n```\n\nRun tests in parallel:\n\n```bash\nnx affected --target=test --parallel=5\n```\n\nRun the test target for all projects:\n\n```bash\nnx affected --target=test --all\n```\n\nRun tests for all the projects affected by changing the index.ts file:\n\n```bash\nnx affected --target=test --files=libs/mylib/src/index.ts\n```\n\nRun tests for all the projects affected by the changes between main and HEAD (e.g., PR):\n\n```bash\nnx affected --target=test --base=main --head=HEAD\n```\n\nRun tests for all the projects affected by the last commit on main:\n\n```bash\nnx affected --target=test --base=main~1 --head=main\n```\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### output-style\n\nType: string\n\nChoices: [dynamic, static, stream, stream-without-prefixes]\n\nDefines how Nx emits outputs tasks logs\n\n### parallel\n\nType: string\n\nMax number of parallel processes [default is 3]\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### target\n\nType: string\n\nTask to run for affected projects\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'affected - CLI command'\ndescription: 'Run target for affected projects'\n---\n\n# affected\n\nRun target for affected projects\n\n## Usage\n\n```bash\nnx affected\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nRun custom target for all affected projects:\n\n````bash\n nx affected --target=custom-target```\nRun tests in parallel:\n```bash\n nx affected --target=test --parallel=5```\nRun the test target for all projects:\n```bash\n nx affected --target=test --all```\nRun tests for all the projects affected by changing the index.ts file:\n```bash\n nx affected --target=test --files=libs/mylib/src/index.ts```\nRun tests for all the projects affected by the changes between main and HEAD (e.g., PR):\n```bash\n nx affected --target=test --base=main --head=HEAD```\nRun tests for all the projects affected by the last commit on main:\n```bash\n nx affected --target=test --base=main~1 --head=main```\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n### help\n\nType: `boolean`\n\nShow help\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n### output-style\n\nType: `string`\n\nChoices: [dynamic, static, stream, stream-without-prefixes]\n\nDefines how Nx emits outputs tasks logs\n### parallel\n\nType: `string`\n\nMax number of parallel processes [default is 3]\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n### target\n\nType: `string`\n\nTask to run for affected projects\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n### untracked\n\nType: `boolean`\n\nUntracked changes\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "affected:graph", "name": "affected:graph",
"id": "affected-dep-graph", "id": "affected-dep-graph",
"file": "generated/cli/affected-graph", "file": "generated/cli/affected-graph",
"content": "---\ntitle: 'affected:graph - CLI command'\ndescription: 'Graph dependencies affected by changes'\n---\n\n# affected:graph\n\nGraph dependencies affected by changes\n\n## Usage\n\n```bash\nnx affected:graph\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nOpen the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:\n\n```bash\nnx affected:graph --files=libs/mylib/src/index.ts\n```\n\nOpen the project graph of the workspace in the browser, and highlight the projects affected by the changes between main and HEAD (e.g., PR):\n\n```bash\nnx affected:graph --base=main --head=HEAD\n```\n\nSave 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):\n\n```bash\nnx affected:graph --base=main --head=HEAD --file=output.json\n```\n\nGenerate 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):\n\n```bash\nnx affected:graph --base=main --head=HEAD --file=output.html\n```\n\nOpen the project graph of the workspace in the browser, and highlight the projects affected by the last commit on main:\n\n```bash\nnx affected:graph --base=main~1 --head=main\n```\n\nOpen the project graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two:\n\n```bash\nnx affected:graph --exclude=project-one,project-two\n```\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### file\n\nType: string\n\nOutput file (e.g. --file=output.json or --file=dep-graph.html)\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### focus\n\nType: string\n\nUse to show the project graph for a particular project and every node that is either an ancestor or a descendant.\n\n### groupByFolder\n\nType: boolean\n\nGroup projects by folder in the project graph\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### host\n\nType: string\n\nBind the project graph server to a specific ip address.\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### open\n\nType: boolean\n\nDefault: true\n\nOpen the project graph in the browser.\n\n### port\n\nType: number\n\nBind the project graph server to a specific port.\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n\n### watch\n\nType: boolean\n\nDefault: false\n\nWatch for changes to project graph and update in-browser\n" "content": "---\ntitle: 'affected:graph - CLI command'\ndescription: 'Graph dependencies affected by changes'\n---\n\n# affected:graph\n\nGraph dependencies affected by changes\n\n## Usage\n\n```bash\nnx affected:graph\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nOpen the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:\n\n````bash\n nx affected:graph --files=libs/mylib/src/index.ts```\nOpen the project graph of the workspace in the browser, and highlight the projects affected by the changes between main and HEAD (e.g., PR):\n```bash\n nx affected:graph --base=main --head=HEAD```\nSave 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):\n```bash\n nx affected:graph --base=main --head=HEAD --file=output.json```\nGenerate 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):\n```bash\n nx affected:graph --base=main --head=HEAD --file=output.html```\nOpen the project graph of the workspace in the browser, and highlight the projects affected by the last commit on main:\n```bash\n nx affected:graph --base=main~1 --head=main```\nOpen the project graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two:\n```bash\n nx affected:graph --exclude=project-one,project-two```\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n### file\n\nType: `string`\n\nOutput file (e.g. --file=output.json or --file=dep-graph.html)\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n### focus\n\nType: `string`\n\nUse to show the project graph for a particular project and every node that is either an ancestor or a descendant.\n### groupByFolder\n\nType: `boolean`\n\nGroup projects by folder in the project graph\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n### help\n\nType: `boolean`\n\nShow help\n### host\n\nType: `string`\n\nBind the project graph server to a specific ip address.\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n### open\n\nType: `boolean`\n\nDefault: `true`\n\nOpen the project graph in the browser.\n### port\n\nType: `number`\n\nBind the project graph server to a specific port.\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n### untracked\n\nType: `boolean`\n\nUntracked changes\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n### version\n\nType: `boolean`\n\nShow version number\n### watch\n\nType: `boolean`\n\nDefault: `false`\n\nWatch for changes to project graph and update in-browser\n````\n"
}, },
{ {
"name": "affected:apps", "name": "affected:apps",
"id": "affected-apps", "id": "affected-apps",
"file": "generated/cli/affected-apps", "file": "generated/cli/affected-apps",
"content": "---\ntitle: 'affected:apps - CLI command'\ndescription: 'Print applications affected by changes'\n---\n\n# affected:apps\n\n**Deprecated:** Use `nx print-affected --type=app ...` instead. This command will be removed in v15.\n\nPrint applications affected by changes\n\n## Usage\n\n```bash\nnx affected:apps\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nPrint the names of all the apps affected by changing the index.ts file:\n\n```bash\nnx affected:apps --files=libs/mylib/src/index.ts\n```\n\nPrint the names of all the apps affected by the changes between main and HEAD (e.g., PR):\n\n```bash\nnx affected:apps --base=main --head=HEAD\n```\n\nPrint the names of all the apps affected by the last commit on main:\n\n```bash\nnx affected:apps --base=main~1 --head=main\n```\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### plain\n\nProduces a plain output for affected:apps and affected:libs\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'affected:apps - CLI command'\ndescription: 'Print applications affected by changes'\n---\n\n# affected:apps\n\n **Deprecated:** Use `nx print-affected --type=app ...` instead. This command will be removed in v15.\n\n Print applications affected by changes\n\n## Usage\n\n```bash\nnx affected:apps\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nPrint the names of all the apps affected by changing the index.ts file:\n\n````bash\n nx affected:apps --files=libs/mylib/src/index.ts```\nPrint the names of all the apps affected by the changes between main and HEAD (e.g., PR):\n```bash\n nx affected:apps --base=main --head=HEAD```\nPrint the names of all the apps affected by the last commit on main:\n```bash\n nx affected:apps --base=main~1 --head=main```\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n### help\n\nType: `boolean`\n\nShow help\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n### plain\n\nProduces a plain output for affected:apps and affected:libs\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n### untracked\n\nType: `boolean`\n\nUntracked changes\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "affected:libs", "name": "affected:libs",
"id": "affected-libs", "id": "affected-libs",
"file": "generated/cli/affected-libs", "file": "generated/cli/affected-libs",
"content": "---\ntitle: 'affected:libs - CLI command'\ndescription: 'Print libraries affected by changes'\n---\n\n# affected:libs\n\n**Deprecated:** Use `nx print-affected --type=lib ...` instead. This command will be removed in v15.\n\nPrint libraries affected by changes\n\n## Usage\n\n```bash\nnx affected:libs\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nPrint the names of all the libs affected by changing the index.ts file:\n\n```bash\nnx affected:libs --files=libs/mylib/src/index.ts\n```\n\nPrint the names of all the libs affected by the changes between main and HEAD (e.g., PR):\n\n```bash\nnx affected:libs --base=main --head=HEAD\n```\n\nPrint the names of all the libs affected by the last commit on main:\n\n```bash\nnx affected:libs --base=main~1 --head=main\n```\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### plain\n\nProduces a plain output for affected:apps and affected:libs\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'affected:libs - CLI command'\ndescription: 'Print libraries affected by changes'\n---\n\n# affected:libs\n\n **Deprecated:** Use `nx print-affected --type=lib ...` instead. This command will be removed in v15.\n\n Print libraries affected by changes\n\n## Usage\n\n```bash\nnx affected:libs\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nPrint the names of all the libs affected by changing the index.ts file:\n\n````bash\n nx affected:libs --files=libs/mylib/src/index.ts```\nPrint the names of all the libs affected by the changes between main and HEAD (e.g., PR):\n```bash\n nx affected:libs --base=main --head=HEAD```\nPrint the names of all the libs affected by the last commit on main:\n```bash\n nx affected:libs --base=main~1 --head=main```\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n### help\n\nType: `boolean`\n\nShow help\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n### plain\n\nProduces a plain output for affected:apps and affected:libs\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n### untracked\n\nType: `boolean`\n\nUntracked changes\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "print-affected", "name": "print-affected",
"id": "print-affected", "id": "print-affected",
"file": "generated/cli/print-affected", "file": "generated/cli/print-affected",
"content": "---\ntitle: 'print-affected - CLI command'\ndescription: 'Prints information about the projects and targets affected by changes'\n---\n\n# print-affected\n\nPrints information about the projects and targets affected by changes\n\n## Usage\n\n```bash\nnx print-affected\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nPrint information about affected projects and the project graph:\n\n```bash\nnx print-affected\n```\n\nPrint information about the projects affected by the changes between main and HEAD (e.g,. PR):\n\n```bash\nnx print-affected --base=main --head=HEAD\n```\n\nPrints information about the affected projects and a list of tasks to test them:\n\n```bash\nnx print-affected --target=test\n```\n\nPrints the projects property from the print-affected output:\n\n```bash\nnx print-affected --target=build --select=projects\n```\n\nPrints the tasks.target.project property from the print-affected output:\n\n```bash\nnx print-affected --target=build --select=tasks.target.project\n```\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### select\n\nType: string\n\nSelect the subset of the returned json document (e.g., --select=projects)\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### type\n\nType: string\n\nChoices: [app, lib]\n\nSelect the type of projects to be returned (e.g., --type=app)\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'print-affected - CLI command'\ndescription: 'Prints information about the projects and targets affected by changes'\n---\n\n# print-affected\n\nPrints information about the projects and targets affected by changes\n\n## Usage\n\n```bash\nnx print-affected\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nPrint information about affected projects and the project graph:\n\n````bash\n nx print-affected```\nPrint information about the projects affected by the changes between main and HEAD (e.g,. PR):\n```bash\n nx print-affected --base=main --head=HEAD```\nPrints information about the affected projects and a list of tasks to test them:\n```bash\n nx print-affected --target=test```\nPrints the projects property from the print-affected output:\n```bash\n nx print-affected --target=build --select=projects```\nPrints the tasks.target.project property from the print-affected output:\n```bash\n nx print-affected --target=build --select=tasks.target.project```\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n### help\n\nType: `boolean`\n\nShow help\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n### select\n\nType: `string`\n\nSelect the subset of the returned json document (e.g., --select=projects)\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n### type\n\nType: `string`\n\nChoices: [app, lib]\n\nSelect the type of projects to be returned (e.g., --type=app)\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n### untracked\n\nType: `boolean`\n\nUntracked changes\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "format:check", "name": "format:check",
"id": "format-check", "id": "format-check",
"tags": ["enforce-project-boundaries"], "tags": ["enforce-project-boundaries"],
"file": "generated/cli/format-check", "file": "generated/cli/format-check",
"content": "---\ntitle: 'format:check - CLI command'\ndescription: 'Check for un-formatted files'\n---\n\n# format:check\n\nCheck for un-formatted files\n\n## Usage\n\n```bash\nnx format:check\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### libs-and-apps\n\nType: boolean\n\nFormat only libraries and applications files.\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### projects\n\nType: array\n\nProjects to format (comma delimited)\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'format:check - CLI command'\ndescription: 'Check for un-formatted files'\n---\n\n# format:check\n\nCheck for un-formatted files\n\n## Usage\n\n```bash\nnx format:check\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: `boolean`\n\nShow help\n\n### libs-and-apps\n\nType: `boolean`\n\nFormat only libraries and applications files.\n\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n\n### projects\n\nType: `array`\n\nProjects to format (comma delimited)\n\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\n\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: `boolean`\n\nShow version number\n"
}, },
{ {
"name": "format:write", "name": "format:write",
"id": "format-write", "id": "format-write",
"tags": ["enforce-project-boundaries"], "tags": ["enforce-project-boundaries"],
"file": "generated/cli/format-write", "file": "generated/cli/format-write",
"content": "---\ntitle: 'format:write - CLI command'\ndescription: 'Overwrite un-formatted files'\n---\n\n# format:write\n\nOverwrite un-formatted files\n\n## Usage\n\n```bash\nnx format:write\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### all\n\nType: boolean\n\nAll projects\n\n### base\n\nType: string\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: string\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: array\n\nDefault: []\n\nExclude certain projects from being processed\n\n### files\n\nType: array\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: string\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: boolean\n\nShow help\n\n### libs-and-apps\n\nType: boolean\n\nFormat only libraries and applications files.\n\n### nx-bail\n\nType: boolean\n\nDefault: false\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: boolean\n\nDefault: false\n\nIgnore cycles in the task graph\n\n### projects\n\nType: array\n\nProjects to format (comma delimited)\n\n### runner\n\nType: string\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: boolean\n\nDefault: false\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: boolean\n\nUncommitted changes\n\n### untracked\n\nType: boolean\n\nUntracked changes\n\n### verbose\n\nType: boolean\n\nDefault: false\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'format:write - CLI command'\ndescription: 'Overwrite un-formatted files'\n---\n\n# format:write\n\nOverwrite un-formatted files\n\n## Usage\n\n```bash\nnx format:write\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### all\n\nType: `boolean`\n\nAll projects\n\n### base\n\nType: `string`\n\nBase of the current branch (usually main)\n\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n\n### files\n\nType: `array`\n\nChange the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas\n\n### head\n\nType: `string`\n\nLatest commit of the current branch (usually HEAD)\n\n### help\n\nType: `boolean`\n\nShow help\n\n### libs-and-apps\n\nType: `boolean`\n\nFormat only libraries and applications files.\n\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n\n### projects\n\nType: `array`\n\nProjects to format (comma delimited)\n\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\n\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: `boolean`\n\nShow version number\n"
}, },
{ {
"name": "migrate", "name": "migrate",
"id": "migrate", "id": "migrate",
"tags": ["automate-updating-dependencies"], "tags": ["automate-updating-dependencies"],
"file": "generated/cli/migrate", "file": "generated/cli/migrate",
"content": "---\ntitle: 'migrate - CLI command'\ndescription:\n 'Creates a migrations file or runs migrations from the migrations file.\n - Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)\n - Run migrations (e.g., nx migrate --run-migrations=migrations.json)'\n---\n\n# migrate\n\nCreates a migrations file or runs migrations from the migrations file.\n\n- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)\n- Run migrations (e.g., nx migrate --run-migrations=migrations.json)\n\n## Usage\n\n```bash\nnx migrate [packageAndVersion]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nUpdate @nrwl/workspace to \"next\". This will update other packages and will generate migrations.json:\n\n```bash\nnx migrate next\n```\n\nUpdate @nrwl/workspace to \"9.0.0\". This will update other packages and will generate migrations.json:\n\n```bash\nnx migrate 9.0.0\n```\n\nUpdate @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what installed locally:\n\n```bash\nnx migrate @nrwl/workspace@9.0.0 --from=\"@nrwl/workspace@8.0.0,@nrwl/node@8.0.0\"\n```\n\nUpdate @nrwl/workspace to \"9.0.0\". If it tries to update @nrwl/react or @nrwl/angular, use version \"9.0.1\":\n\n```bash\nnx migrate @nrwl/workspace@9.0.0 --to=\"@nrwl/react@9.0.1,@nrwl/angular@9.0.1\"\n```\n\nUpdate another-package to \"12.0.0\". This will update other packages and will generate migrations.json file:\n\n```bash\nnx migrate another-package@12.0.0\n```\n\nRun migrations from the provided migrations.json file. You can modify migrations.json and run this command many times:\n\n```bash\nnx migrate --run-migrations=migrations.json\n```\n\nCreate a dedicated commit for each successfully completed migration. You can customize the prefix used for each commit by additionally setting --commit-prefix=\"PREFIX_HERE \":\n\n```bash\nnx migrate --run-migrations --create-commits\n```\n\n## Options\n\n### commitPrefix\n\nType: string\n\nDefault: chore: [nx migration]\n\nCommit prefix to apply to the commit for each migration, when --create-commits is enabled\n\n### createCommits\n\nType: boolean\n\nDefault: false\n\nAutomatically create a git commit after each migration runs\n\n### from\n\nType: string\n\nUse the provided versions for packages instead of the ones installed in node_modules (e.g., --from=\"@nrwl/react:12.0.0,@nrwl/js:12.0.0\")\n\n### help\n\nType: boolean\n\nShow help\n\n### packageAndVersion\n\nType: string\n\nThe target package and version (e.g, @nrwl/workspace@13.0.0)\n\n### runMigrations\n\nType: string\n\nExecute migrations from a file (when the file isn't provided, execute migrations from migrations.json)\n\n### to\n\nType: string\n\nUse the provided versions for packages instead of the ones calculated by the migrator (e.g., --to=\"@nrwl/react:12.0.0,@nrwl/js:12.0.0\")\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'migrate - CLI command'\ndescription:\n 'Creates a migrations file or runs migrations from the migrations file.\n - Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)\n - Run migrations (e.g., nx migrate --run-migrations=migrations.json)'\n---\n\n# migrate\n\nCreates a migrations file or runs migrations from the migrations file.\n\n- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)\n- Run migrations (e.g., nx migrate --run-migrations=migrations.json)\n\n## Usage\n\n```bash\nnx migrate [packageAndVersion]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nUpdate @nrwl/workspace to \"next\". This will update other packages and will generate migrations.json:\n\n````bash\n nx migrate next```\nUpdate @nrwl/workspace to \"9.0.0\". This will update other packages and will generate migrations.json:\n```bash\n nx migrate 9.0.0```\nUpdate @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what installed locally:\n```bash\n nx migrate @nrwl/workspace@9.0.0 --from=\"@nrwl/workspace@8.0.0,@nrwl/node@8.0.0\"```\nUpdate @nrwl/workspace to \"9.0.0\". If it tries to update @nrwl/react or @nrwl/angular, use version \"9.0.1\":\n```bash\n nx migrate @nrwl/workspace@9.0.0 --to=\"@nrwl/react@9.0.1,@nrwl/angular@9.0.1\"```\nUpdate another-package to \"12.0.0\". This will update other packages and will generate migrations.json file:\n```bash\n nx migrate another-package@12.0.0```\nRun migrations from the provided migrations.json file. You can modify migrations.json and run this command many times:\n```bash\n nx migrate --run-migrations=migrations.json```\nCreate a dedicated commit for each successfully completed migration. You can customize the prefix used for each commit by additionally setting --commit-prefix=\"PREFIX_HERE \":\n```bash\n nx migrate --run-migrations --create-commits```\n\n## Options\n\n### commitPrefix\n\nType: `string`\n\nDefault: `chore: [nx migration] `\n\nCommit prefix to apply to the commit for each migration, when --create-commits is enabled\n### createCommits\n\nType: `boolean`\n\nDefault: `false`\n\nAutomatically create a git commit after each migration runs\n### from\n\nType: `string`\n\nUse the provided versions for packages instead of the ones installed in node_modules (e.g., --from=\"@nrwl/react:12.0.0,@nrwl/js:12.0.0\")\n### help\n\nType: `boolean`\n\nShow help\n### packageAndVersion\n\nType: `string`\n\nThe target package and version (e.g, @nrwl/workspace@13.0.0)\n### runMigrations\n\nType: `string`\n\nExecute migrations from a file (when the file isn't provided, execute migrations from migrations.json)\n### to\n\nType: `string`\n\nUse the provided versions for packages instead of the ones calculated by the migrator (e.g., --to=\"@nrwl/react:12.0.0,@nrwl/js:12.0.0\")\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "report", "name": "report",
@ -114,7 +114,7 @@
"name": "list", "name": "list",
"id": "list", "id": "list",
"file": "generated/cli/list", "file": "generated/cli/list",
"content": "---\ntitle: 'list - CLI command'\ndescription: 'Lists installed plugins, capabilities of installed plugins and other available plugins.'\n---\n\n# list\n\nLists installed plugins, capabilities of installed plugins and other available plugins.\n\n## Usage\n\n```bash\nnx list [plugin]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nList the plugins installed in the current workspace:\n\n```bash\nnx list\n```\n\nList the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):\n\n```bash\nnx list @nrwl/web\n```\n\n## Options\n\n### help\n\nType: boolean\n\nShow help\n\n### plugin\n\nType: string\n\nThe name of an installed plugin to query\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'list - CLI command'\ndescription: 'Lists installed plugins, capabilities of installed plugins and other available plugins.'\n---\n\n# list\n\nLists installed plugins, capabilities of installed plugins and other available plugins.\n\n## Usage\n\n```bash\nnx list [plugin]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nList the plugins installed in the current workspace:\n\n````bash\n nx list```\nList the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):\n```bash\n nx list @nrwl/web```\n\n## Options\n\n### help\n\nType: `boolean`\n\nShow help\n### plugin\n\nType: `string`\n\nThe name of an installed plugin to query\n### version\n\nType: `boolean`\n\nShow version number\n````\n"
}, },
{ {
"name": "workspace-lint", "name": "workspace-lint",
@ -127,14 +127,14 @@
"name": "workspace-generator", "name": "workspace-generator",
"id": "workspace-generator", "id": "workspace-generator",
"file": "generated/cli/workspace-generator", "file": "generated/cli/workspace-generator",
"content": "---\ntitle: 'workspace-generator - CLI command'\ndescription: 'Runs a workspace generator from the tools/generators directory'\n---\n\n# workspace-generator\n\nRuns a workspace generator from the tools/generators directory\n\n## Usage\n\n```bash\nnx workspace-generator [name]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: boolean\n\nShow help\n\n### list-generators\n\nType: boolean\n\nList the available workspace-generators\n\n### name\n\nType: string\n\nThe name of your generator\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'workspace-generator - CLI command'\ndescription: 'Runs a workspace generator from the tools/generators directory'\n---\n\n# workspace-generator\n\nRuns a workspace generator from the tools/generators directory\n\n## Usage\n\n```bash\nnx workspace-generator [name]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: `boolean`\n\nShow help\n\n### list-generators\n\nType: `boolean`\n\nList the available workspace-generators\n\n### name\n\nType: `string`\n\nThe name of your generator\n\n### version\n\nType: `boolean`\n\nShow version number\n"
}, },
{ {
"name": "connect-to-nx-cloud", "name": "connect-to-nx-cloud",
"id": "connect-to-nx-cloud", "id": "connect-to-nx-cloud",
"tags": ["cache-task-results", "distribute-task-execution"], "tags": ["cache-task-results", "distribute-task-execution"],
"file": "generated/cli/connect-to-nx-cloud", "file": "generated/cli/connect-to-nx-cloud",
"content": "---\ntitle: 'connect-to-nx-cloud - CLI command'\ndescription: 'Makes sure the workspace is connected to Nx Cloud'\n---\n\n# connect-to-nx-cloud\n\nMakes sure the workspace is connected to Nx Cloud\n\n## Usage\n\n```bash\nnx connect-to-nx-cloud\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: boolean\n\nShow help\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'connect-to-nx-cloud - CLI command'\ndescription: 'Makes sure the workspace is connected to Nx Cloud'\n---\n\n# connect-to-nx-cloud\n\nMakes sure the workspace is connected to Nx Cloud\n\n## Usage\n\n```bash\nnx connect-to-nx-cloud\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: `boolean`\n\nShow help\n\n### version\n\nType: `boolean`\n\nShow version number\n"
}, },
{ {
"name": "reset", "name": "reset",
@ -147,7 +147,7 @@
"name": "repair", "name": "repair",
"id": "repair", "id": "repair",
"file": "generated/cli/repair", "file": "generated/cli/repair",
"content": "---\ntitle: 'repair - CLI command'\ndescription: 'Repair any configuration that is no longer supported by Nx.'\n---\n\n# repair\n\nRepair any configuration that is no longer supported by Nx.\n\n## Usage\n\n```bash\nnx repair\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: boolean\n\nShow help\n\n### verbose\n\nType: boolean\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: boolean\n\nShow version number\n" "content": "---\ntitle: 'repair - CLI command'\ndescription: 'Repair any configuration that is no longer supported by Nx.'\n---\n\n# repair\n\nRepair any configuration that is no longer supported by Nx.\n\n## Usage\n\n```bash\nnx repair\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n## Options\n\n### help\n\nType: `boolean`\n\nShow help\n\n### verbose\n\nType: `boolean`\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: `boolean`\n\nShow version number\n"
} }
], ],
"generators": [], "generators": [],

15
scripts/documentation/generate-cli-data.ts
View File

@ -3,7 +3,6 @@ import { readFileSync } from 'fs';
import { readJsonSync } from 'fs-extra'; import { readJsonSync } from 'fs-extra';
import { join } from 'path'; import { join } from 'path';
import { register as registerTsConfigPaths } from 'tsconfig-paths'; import { register as registerTsConfigPaths } from 'tsconfig-paths';
import { dedent } from 'tslint/lib/utils';
import { examples } from '../../packages/nx/src/command-line/examples'; import { examples } from '../../packages/nx/src/command-line/examples';
import { import {
formatDeprecated, formatDeprecated,
@ -40,14 +39,15 @@ export async function generateCliDocumentation(
); );
function generateMarkdown(command: ParsedCommand) { function generateMarkdown(command: ParsedCommand) {
let template = dedent` let template = `
--- ---
title: "${command.name} - CLI command" title: "${command.name} - CLI command"
description: "${command.description}" description: "${command.description}"
--- ---
# ${command.name} # ${command.name}
${dedent`${formatDeprecated(command.description, command.deprecated)}`} ${formatDeprecated(command.description, command.deprecated)}
## Usage ## Usage
@ -58,14 +58,9 @@ nx ${command.commandString}
Install \`nx\` globally to invoke the command directly using \`nx\`, or use \`npx nx\`, \`yarn nx\`, or \`pnpm nx\`.\n`; Install \`nx\` globally to invoke the command directly using \`nx\`, or use \`npx nx\`, \`yarn nx\`, or \`pnpm nx\`.\n`;
if (examples[command.name] && examples[command.name].length > 0) { if (examples[command.name] && examples[command.name].length > 0) {
template += `\n### Examples`; template += `\n### Examples\n`;
examples[command.name].forEach((example) => { examples[command.name].forEach((example) => {
template += dedent` template += `${example.description}:\n\`\`\`bash\n nx ${example.command}\`\`\`\n`;
${example.description}:
\`\`\`bash
nx ${example.command}
\`\`\`
`;
}); });
} }

6
scripts/documentation/generate-cnw-documentation.ts
View File

@ -1,5 +1,4 @@
import * as chalk from 'chalk'; import * as chalk from 'chalk';
import { dedent } from 'tslint/lib/utils';
import { import {
generateMarkdownFile, generateMarkdownFile,
generateOptionsMarkdown, generateOptionsMarkdown,
@ -40,7 +39,7 @@ export async function generateCnwDocumentation(
} }
function generateMarkdown(command: ParsedCommand) { function generateMarkdown(command: ParsedCommand) {
let template = dedent` let template = `
--- ---
title: "${command.name} - CLI command" title: "${command.name} - CLI command"
description: "${command.description}" description: "${command.description}"
@ -55,7 +54,8 @@ function generateMarkdown(command: ParsedCommand) {
${command.commandString} ${command.commandString}
\`\`\` \`\`\`
Install \`create-nx-workspace\` globally to invoke the command directly, or use \`npx create-nx-workspace\`, \`yarn create nx-workspace\`, or \`pnpx create-nx-workspace\`.\n`; Install \`create-nx-workspace\` globally to invoke the command directly, or use \`npx create-nx-workspace\`, \`yarn create nx-workspace\`, or \`pnpx create-nx-workspace\`.\n
`;
template += generateOptionsMarkdown(command); template += generateOptionsMarkdown(command);

26
scripts/documentation/utils.ts
View File

@ -1,7 +1,6 @@
import { outputFileSync, readJsonSync } from 'fs-extra'; import { outputFileSync, readJsonSync } from 'fs-extra';
import { join } from 'path'; import { join } from 'path';
import { format, resolveConfig } from 'prettier'; import { format, resolveConfig } from 'prettier';
import { dedent } from 'tslint/lib/utils';
const stripAnsi = require('strip-ansi'); const stripAnsi = require('strip-ansi');
const importFresh = require('import-fresh'); const importFresh = require('import-fresh');
@ -196,25 +195,26 @@ export function generateOptionsMarkdown(command): string {
command.options command.options
.sort((a, b) => sortAlphabeticallyFunction(a.name, b.name)) .sort((a, b) => sortAlphabeticallyFunction(a.name, b.name))
.forEach((option) => { .forEach((option) => {
response += dedent` response += `\n### ${
### ${option.deprecated ? `~~${option.name}~~` : option.name} option.deprecated ? `~~${option.name}~~` : option.name
`; }\n`;
if (option.type !== undefined && option.type !== '') { if (option.type !== undefined && option.type !== '') {
response += `Type: ${option.type}\n`; response += `\nType: \`${option.type}\`\n`;
} }
if (option.choices !== undefined) { if (option.choices !== undefined) {
response += dedent` const choices = option.choices
Choices: [${option.choices
.map((c) => JSON.stringify(c).replace(/"/g, '')) .map((c) => JSON.stringify(c).replace(/"/g, ''))
.join(', ')}]\n`; .join(', ');
response += `\nChoices: [${choices}]\n`;
} }
if (option.default !== undefined && option.default !== '') { if (option.default !== undefined && option.default !== '') {
response += dedent` response += `\nDefault: \`${JSON.stringify(option.default).replace(
Default: ${JSON.stringify(option.default).replace(/"/g, '')}\n`; /"/g,
''
)}\`\n`;
} }
response += dedent` response +=
${formatDeprecated(option.description, option.deprecated)} '\n' + formatDeprecated(option.description, option.deprecated);
`;
}); });
} }
return response; return response;