From 315bf0c9684e914c06f5f1f0188b08cc618ee0da Mon Sep 17 00:00:00 2001 From: Benjamin Cabanes <3447705+bcabanes@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:39:00 -0500 Subject: [PATCH] docs(nxdev): use shell marker for command-line (#13824) --- docs/generated/cli/affected-apps.md | 8 ++--- docs/generated/cli/affected-graph.md | 14 ++++---- docs/generated/cli/affected-libs.md | 8 ++--- docs/generated/cli/affected.md | 16 ++++----- docs/generated/cli/connect.md | 2 +- docs/generated/cli/daemon.md | 2 +- docs/generated/cli/exec.md | 2 +- docs/generated/cli/format-check.md | 2 +- docs/generated/cli/format-write.md | 2 +- docs/generated/cli/graph.md | 18 +++++----- docs/generated/cli/init.md | 2 +- docs/generated/cli/list.md | 6 ++-- docs/generated/cli/migrate.md | 16 ++++----- docs/generated/cli/print-affected.md | 12 +++---- docs/generated/cli/repair.md | 2 +- docs/generated/cli/report.md | 2 +- docs/generated/cli/reset.md | 2 +- docs/generated/cli/run-many.md | 10 +++--- docs/generated/cli/watch.md | 8 ++--- docs/generated/cli/workspace-generator.md | 2 +- docs/generated/cli/workspace-lint.md | 2 +- docs/generated/packages/nx.json | 42 +++++++++++----------- scripts/documentation/generate-cli-data.ts | 4 +-- 23 files changed, 92 insertions(+), 92 deletions(-) diff --git a/docs/generated/cli/affected-apps.md b/docs/generated/cli/affected-apps.md index f317f38e735f9..3a012aa50e8d7 100644 --- a/docs/generated/cli/affected-apps.md +++ b/docs/generated/cli/affected-apps.md @@ -11,7 +11,7 @@ description: 'Print applications affected by changes' ## Usage -```terminal +```shell nx affected:apps ``` @@ -21,19 +21,19 @@ 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: -```terminal +```shell 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): -```terminal +```shell nx affected:apps --base=main --head=HEAD ``` Print the names of all the apps affected by the last commit on main: -```terminal +```shell nx affected:apps --base=main~1 --head=main ``` diff --git a/docs/generated/cli/affected-graph.md b/docs/generated/cli/affected-graph.md index 056645fc8094f..e7d73c28ce78f 100644 --- a/docs/generated/cli/affected-graph.md +++ b/docs/generated/cli/affected-graph.md @@ -9,7 +9,7 @@ Graph dependencies affected by changes ## Usage -```terminal +```shell nx affected:graph ``` @@ -19,37 +19,37 @@ 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: -```terminal +```shell 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): -```terminal +```shell 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): -```terminal +```shell 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): -```terminal +```shell 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: -```terminal +```shell 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: -```terminal +```shell nx affected:graph --exclude=project-one,project-two ``` diff --git a/docs/generated/cli/affected-libs.md b/docs/generated/cli/affected-libs.md index 61e9f06cc177a..5a2d6cd60b67e 100644 --- a/docs/generated/cli/affected-libs.md +++ b/docs/generated/cli/affected-libs.md @@ -11,7 +11,7 @@ description: 'Print libraries affected by changes' ## Usage -```terminal +```shell nx affected:libs ``` @@ -21,19 +21,19 @@ 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: -```terminal +```shell 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): -```terminal +```shell nx affected:libs --base=main --head=HEAD ``` Print the names of all the libs affected by the last commit on main: -```terminal +```shell nx affected:libs --base=main~1 --head=main ``` diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md index 1c04e5e013d7f..b7896570a2a1c 100644 --- a/docs/generated/cli/affected.md +++ b/docs/generated/cli/affected.md @@ -9,7 +9,7 @@ Run target for affected projects ## Usage -```terminal +```shell nx affected ``` @@ -19,43 +19,43 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Run custom target for all affected projects: -```terminal +```shell nx affected --target=custom-target ``` Run tests in parallel: -```terminal +```shell nx affected --target=test --parallel=5 ``` Run the test target for all projects: -```terminal +```shell nx affected --target=test --all ``` Run tests for all the projects affected by changing the index.ts file: -```terminal +```shell 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): -```terminal +```shell nx affected --target=test --base=main --head=HEAD ``` Run tests for all the projects affected by the last commit on main: -```terminal +```shell nx affected --target=test --base=main~1 --head=main ``` Use the currently executing project name in your command.: -```terminal +```shell nx affected --target=build --tag=$NX_TARGET_TASK_PROJECT:latest ``` diff --git a/docs/generated/cli/connect.md b/docs/generated/cli/connect.md index 40aced40e5fe0..247c3df195843 100644 --- a/docs/generated/cli/connect.md +++ b/docs/generated/cli/connect.md @@ -9,7 +9,7 @@ Connect workspace to Nx Cloud ## Usage -```terminal +```shell nx connect ``` diff --git a/docs/generated/cli/daemon.md b/docs/generated/cli/daemon.md index 100d2aba40092..d9f12325e5710 100644 --- a/docs/generated/cli/daemon.md +++ b/docs/generated/cli/daemon.md @@ -9,7 +9,7 @@ Prints information about the Nx Daemon process or starts a daemon process ## Usage -```terminal +```shell nx daemon ``` diff --git a/docs/generated/cli/exec.md b/docs/generated/cli/exec.md index 5b172ea1cac5c..fe4658f799db8 100644 --- a/docs/generated/cli/exec.md +++ b/docs/generated/cli/exec.md @@ -9,7 +9,7 @@ Executes any command as if it was a target on the project ## Usage -```terminal +```shell nx exec ``` diff --git a/docs/generated/cli/format-check.md b/docs/generated/cli/format-check.md index 01a937dd854cd..4c5d2795cbb59 100644 --- a/docs/generated/cli/format-check.md +++ b/docs/generated/cli/format-check.md @@ -9,7 +9,7 @@ Check for un-formatted files ## Usage -```terminal +```shell nx format:check ``` diff --git a/docs/generated/cli/format-write.md b/docs/generated/cli/format-write.md index 573103262b7ce..80df4c283724b 100644 --- a/docs/generated/cli/format-write.md +++ b/docs/generated/cli/format-write.md @@ -9,7 +9,7 @@ Overwrite un-formatted files ## Usage -```terminal +```shell nx format:write ``` diff --git a/docs/generated/cli/graph.md b/docs/generated/cli/graph.md index c88de23efe7c7..4152b0323e001 100644 --- a/docs/generated/cli/graph.md +++ b/docs/generated/cli/graph.md @@ -9,7 +9,7 @@ Graph dependencies within workspace ## Usage -```terminal +```shell nx graph ``` @@ -19,49 +19,49 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Open the project graph of the workspace in the browser: -```terminal +```shell nx graph ``` Save the project graph into a json file: -```terminal +```shell nx graph --file=output.json ``` Generate a static website with project graph into an html file, accompanied by an asset folder called static: -```terminal +```shell nx graph --file=output.html ``` Show the graph where every node is either an ancestor or a descendant of todos-feature-main: -```terminal +```shell nx graph --focus=todos-feature-main ``` Include project-one and project-two in the project graph: -```terminal +```shell nx graph --include=project-one,project-two ``` Exclude project-one and project-two from the project graph: -```terminal +```shell 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: -```terminal +```shell nx graph --focus=todos-feature-main --exclude=project-one,project-two ``` Watch for changes to project graph and update in-browser: -```terminal +```shell nx graph --watch ``` diff --git a/docs/generated/cli/init.md b/docs/generated/cli/init.md index e3980a0bc987b..25a3d60b02e5b 100644 --- a/docs/generated/cli/init.md +++ b/docs/generated/cli/init.md @@ -9,7 +9,7 @@ Adds nx.json file and installs nx if not installed already ## Usage -```terminal +```shell nx init ``` diff --git a/docs/generated/cli/list.md b/docs/generated/cli/list.md index 613f69ade9631..ae5c2bf3eb085 100644 --- a/docs/generated/cli/list.md +++ b/docs/generated/cli/list.md @@ -9,7 +9,7 @@ Lists installed plugins, capabilities of installed plugins and other available p ## Usage -```terminal +```shell nx list [plugin] ``` @@ -19,13 +19,13 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` List the plugins installed in the current workspace: -```terminal +```shell 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): -```terminal +```shell nx list @nrwl/web ``` diff --git a/docs/generated/cli/migrate.md b/docs/generated/cli/migrate.md index 351b3b8d0e077..81655296c2d06 100644 --- a/docs/generated/cli/migrate.md +++ b/docs/generated/cli/migrate.md @@ -15,7 +15,7 @@ Creates a migrations file or runs migrations from the migrations file. ## Usage -```terminal +```shell nx migrate [packageAndVersion] ``` @@ -25,43 +25,43 @@ 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: -```terminal +```shell nx migrate next ``` Update @nrwl/workspace to "9.0.0". This will update other packages and will generate migrations.json: -```terminal +```shell 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: -```terminal +```shell 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": -```terminal +```shell 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: -```terminal +```shell 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: -```terminal +```shell 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 ": -```terminal +```shell nx migrate --run-migrations --create-commits ``` diff --git a/docs/generated/cli/print-affected.md b/docs/generated/cli/print-affected.md index d834298a43a0e..27a0e86547bcb 100644 --- a/docs/generated/cli/print-affected.md +++ b/docs/generated/cli/print-affected.md @@ -9,7 +9,7 @@ Prints information about the projects and targets affected by changes ## Usage -```terminal +```shell nx print-affected ``` @@ -19,31 +19,31 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Print information about affected projects and the project graph: -```terminal +```shell nx print-affected ``` Print information about the projects affected by the changes between main and HEAD (e.g,. PR): -```terminal +```shell nx print-affected --base=main --head=HEAD ``` Prints information about the affected projects and a list of tasks to test them: -```terminal +```shell nx print-affected --target=test ``` Prints the projects property from the print-affected output: -```terminal +```shell nx print-affected --target=build --select=projects ``` Prints the tasks.target.project property from the print-affected output: -```terminal +```shell nx print-affected --target=build --select=tasks.target.project ``` diff --git a/docs/generated/cli/repair.md b/docs/generated/cli/repair.md index c560215a28e94..ec8253216a81a 100644 --- a/docs/generated/cli/repair.md +++ b/docs/generated/cli/repair.md @@ -9,7 +9,7 @@ Repair any configuration that is no longer supported by Nx. ## Usage -```terminal +```shell nx repair ``` diff --git a/docs/generated/cli/report.md b/docs/generated/cli/report.md index 8b9c93cbd9d35..6b7e88a2901a7 100644 --- a/docs/generated/cli/report.md +++ b/docs/generated/cli/report.md @@ -9,7 +9,7 @@ Reports useful version numbers to copy into the Nx issue template ## Usage -```terminal +```shell nx report ``` diff --git a/docs/generated/cli/reset.md b/docs/generated/cli/reset.md index bdc1226806744..7f036bb07d82d 100644 --- a/docs/generated/cli/reset.md +++ b/docs/generated/cli/reset.md @@ -9,7 +9,7 @@ Clears all the cached Nx artifacts and metadata about the workspace and shuts do ## Usage -```terminal +```shell nx reset ``` diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md index 50ff156d3f2b8..8db25d371fd70 100644 --- a/docs/generated/cli/run-many.md +++ b/docs/generated/cli/run-many.md @@ -9,7 +9,7 @@ Run target for multiple listed projects ## Usage -```terminal +```shell nx run-many ``` @@ -19,25 +19,25 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Test all projects: -```terminal +```shell nx run-many --target=test ``` Test proj1 and proj2: -```terminal +```shell nx run-many --target=test --projects=proj1,proj2 ``` Test proj1 and proj2 in parallel: -```terminal +```shell nx run-many --target=test --projects=proj1,proj2 --parallel=2 ``` Test all projects ending with `*-app` except `excluded-app`: -```terminal +```shell nx run-many --target=test --projects=*-app --exclude excluded-app ``` diff --git a/docs/generated/cli/watch.md b/docs/generated/cli/watch.md index ccea9135a7f4e..6d608b5f0ea72 100644 --- a/docs/generated/cli/watch.md +++ b/docs/generated/cli/watch.md @@ -9,7 +9,7 @@ Watch for changes within projects, and execute commands ## Usage -```terminal +```shell nx watch ``` @@ -19,19 +19,19 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Watch the "app" project and echo the project name and the files that changed: -```terminal +```shell nx watch --projects=app -- echo \$NX_PROJECT_NAME \$NX_FILE_CHANGES ``` Watch "app1" and "app2" and echo the project name whenever a specified project or its dependencies change: -```terminal +```shell nx watch --projects=app1,app2 --includeDependencies -- echo \$NX_PROJECT_NAME ``` Watch all projects (including newly created projects) in the workspace: -```terminal +```shell nx watch --all -- echo \$NX_PROJECT_NAME ``` diff --git a/docs/generated/cli/workspace-generator.md b/docs/generated/cli/workspace-generator.md index c602609d311a8..1c471c86aac55 100644 --- a/docs/generated/cli/workspace-generator.md +++ b/docs/generated/cli/workspace-generator.md @@ -9,7 +9,7 @@ Runs a workspace generator from the tools/generators directory ## Usage -```terminal +```shell nx workspace-generator [name] ``` diff --git a/docs/generated/cli/workspace-lint.md b/docs/generated/cli/workspace-lint.md index c5bc40d3a8198..d119c1a14d6d7 100644 --- a/docs/generated/cli/workspace-lint.md +++ b/docs/generated/cli/workspace-lint.md @@ -9,7 +9,7 @@ Lint nx specific workspace files (nx.json, workspace.json) ## Usage -```terminal +```shell nx workspace-lint [files..] ``` diff --git a/docs/generated/packages/nx.json b/docs/generated/packages/nx.json index bd092fd7a924e..c441aae870d06 100644 --- a/docs/generated/packages/nx.json +++ b/docs/generated/packages/nx.json @@ -16,7 +16,7 @@ "name": "init", "id": "init", "file": "generated/cli/init", - "content": "---\ntitle: 'init - CLI command'\ndescription: 'Adds nx.json file and installs nx if not installed already'\n---\n\n# init\n\nAdds nx.json file and installs nx if not installed already\n\n## Usage\n\n```terminal\nnx init\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" + "content": "---\ntitle: 'init - CLI command'\ndescription: 'Adds nx.json file and installs nx if not installed already'\n---\n\n# init\n\nAdds nx.json file and installs nx if not installed already\n\n## Usage\n\n```shell\nnx init\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" }, { "name": "generate", @@ -36,131 +36,131 @@ "name": "daemon", "id": "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```terminal\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```shell\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", "id": "dep-graph", "tags": ["explore-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```terminal\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```terminal\n nx graph\n```\n\nSave the project graph into a json file:\n\n```terminal\n nx 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```terminal\n nx 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```terminal\n nx graph --focus=todos-feature-main\n```\n\nInclude project-one and project-two in the project graph:\n\n```terminal\n nx graph --include=project-one,project-two\n```\n\nExclude project-one and project-two from the project graph:\n\n```terminal\n nx 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```terminal\n nx graph --focus=todos-feature-main --exclude=project-one,project-two\n```\n\nWatch for changes to project graph and update in-browser:\n\n```terminal\n nx 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```shell\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```shell\n nx graph\n```\n\nSave the project graph into a json file:\n\n```shell\n nx 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```shell\n nx 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```shell\n nx graph --focus=todos-feature-main\n```\n\nInclude project-one and project-two in the project graph:\n\n```shell\n nx graph --include=project-one,project-two\n```\n\nExclude project-one and project-two from the project graph:\n\n```shell\n nx 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```shell\n nx graph --focus=todos-feature-main --exclude=project-one,project-two\n```\n\nWatch for changes to project graph and update in-browser:\n\n```shell\n nx 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" }, { "name": "run-many", "tags": ["run-tasks", "use-task-executors"], "id": "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```terminal\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```terminal\n nx run-many --target=test\n```\n\nTest proj1 and proj2:\n\n```terminal\n nx run-many --target=test --projects=proj1,proj2\n```\n\nTest proj1 and proj2 in parallel:\n\n```terminal\n nx run-many --target=test --projects=proj1,proj2 --parallel=2\n```\n\nTest all projects ending with `*-app` except `excluded-app`:\n\n```terminal\n nx run-many --target=test --projects=*-app --exclude excluded-app\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 project names and/or patterns)\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### 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```shell\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```shell\n nx run-many --target=test\n```\n\nTest proj1 and proj2:\n\n```shell\n nx run-many --target=test --projects=proj1,proj2\n```\n\nTest proj1 and proj2 in parallel:\n\n```shell\n nx run-many --target=test --projects=proj1,proj2 --parallel=2\n```\n\nTest all projects ending with `*-app` except `excluded-app`:\n\n```shell\n nx run-many --target=test --projects=*-app --exclude excluded-app\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 project names and/or patterns)\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### 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": "affected", "tags": ["run-tasks", "use-task-executors"], "id": "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```terminal\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```terminal\n nx affected --target=custom-target\n```\n\nRun tests in parallel:\n\n```terminal\n nx affected --target=test --parallel=5\n```\n\nRun the test target for all projects:\n\n```terminal\n nx affected --target=test --all\n```\n\nRun tests for all the projects affected by changing the index.ts file:\n\n```terminal\n nx 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```terminal\n nx affected --target=test --base=main --head=HEAD\n```\n\nRun tests for all the projects affected by the last commit on main:\n\n```terminal\n nx affected --target=test --base=main~1 --head=main\n```\n\nUse the currently executing project name in your command.:\n\n```terminal\n nx affected --target=build --tag=$NX_TARGET_TASK_PROJECT:latest\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```shell\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```shell\n nx affected --target=custom-target\n```\n\nRun tests in parallel:\n\n```shell\n nx affected --target=test --parallel=5\n```\n\nRun the test target for all projects:\n\n```shell\n nx affected --target=test --all\n```\n\nRun tests for all the projects affected by changing the index.ts file:\n\n```shell\n nx 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```shell\n nx affected --target=test --base=main --head=HEAD\n```\n\nRun tests for all the projects affected by the last commit on main:\n\n```shell\n nx affected --target=test --base=main~1 --head=main\n```\n\nUse the currently executing project name in your command.:\n\n```shell\n nx affected --target=build --tag=$NX_TARGET_TASK_PROJECT:latest\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" }, { "name": "affected:graph", "id": "affected-dep-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```terminal\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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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### 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### 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### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\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```shell\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```shell\n nx 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```shell\n nx 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```shell\n nx 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```shell\n nx 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```shell\n nx 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```shell\n nx 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### 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### 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### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\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" }, { "name": "affected:apps", "id": "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\n Print applications affected by changes\n\n## Usage\n\n```terminal\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```terminal\n nx 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```terminal\n nx affected:apps --base=main --head=HEAD\n```\n\nPrint the names of all the apps affected by the last commit on main:\n\n```terminal\n nx 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### 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### plain\n\nProduces a plain output for affected:apps and affected:libs\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\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```shell\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```shell\n nx 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```shell\n nx affected:apps --base=main --head=HEAD\n```\n\nPrint the names of all the apps affected by the last commit on main:\n\n```shell\n nx 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### 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### plain\n\nProduces a plain output for affected:apps and affected:libs\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\n\n### version\n\nType: `boolean`\n\nShow version number\n" }, { "name": "affected:libs", "id": "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\n Print libraries affected by changes\n\n## Usage\n\n```terminal\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```terminal\n nx 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```terminal\n nx affected:libs --base=main --head=HEAD\n```\n\nPrint the names of all the libs affected by the last commit on main:\n\n```terminal\n nx 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### 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### plain\n\nProduces a plain output for affected:apps and affected:libs\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\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```shell\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```shell\n nx 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```shell\n nx affected:libs --base=main --head=HEAD\n```\n\nPrint the names of all the libs affected by the last commit on main:\n\n```shell\n nx 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### 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### plain\n\nProduces a plain output for affected:apps and affected:libs\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\n\n### version\n\nType: `boolean`\n\nShow version number\n" }, { "name": "print-affected", "id": "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```terminal\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```terminal\n nx print-affected\n```\n\nPrint information about the projects affected by the changes between main and HEAD (e.g,. PR):\n\n```terminal\n nx print-affected --base=main --head=HEAD\n```\n\nPrints information about the affected projects and a list of tasks to test them:\n\n```terminal\n nx print-affected --target=test\n```\n\nPrints the projects property from the print-affected output:\n\n```terminal\n nx print-affected --target=build --select=projects\n```\n\nPrints the tasks.target.project property from the print-affected output:\n\n```terminal\n nx 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### select\n\nType: `string`\n\nSelect the subset of the returned json document (e.g., --select=projects)\n\n### target\n\nType: `string`\n\nTask to run for affected projects\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### 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```shell\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```shell\n nx print-affected\n```\n\nPrint information about the projects affected by the changes between main and HEAD (e.g,. PR):\n\n```shell\n nx print-affected --base=main --head=HEAD\n```\n\nPrints information about the affected projects and a list of tasks to test them:\n\n```shell\n nx print-affected --target=test\n```\n\nPrints the projects property from the print-affected output:\n\n```shell\n nx print-affected --target=build --select=projects\n```\n\nPrints the tasks.target.project property from the print-affected output:\n\n```shell\n nx 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### select\n\nType: `string`\n\nSelect the subset of the returned json document (e.g., --select=projects)\n\n### target\n\nType: `string`\n\nTask to run for affected projects\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### version\n\nType: `boolean`\n\nShow version number\n" }, { "name": "format:check", "id": "format-check", "tags": ["enforce-project-boundaries"], "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```terminal\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### 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### projects\n\nType: `array`\n\nProjects to format (comma delimited)\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\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```shell\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### 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### projects\n\nType: `array`\n\nProjects to format (comma delimited)\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\n\n### version\n\nType: `boolean`\n\nShow version number\n" }, { "name": "format:write", "id": "format-write", "tags": ["enforce-project-boundaries"], "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```terminal\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### 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### projects\n\nType: `array`\n\nProjects to format (comma delimited)\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\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```shell\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### 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### projects\n\nType: `array`\n\nProjects to format (comma delimited)\n\n### uncommitted\n\nType: `boolean`\n\nUncommitted changes\n\n### untracked\n\nType: `boolean`\n\nUntracked changes\n\n### version\n\nType: `boolean`\n\nShow version number\n" }, { "name": "migrate", "id": "migrate", "tags": ["automate-updating-dependencies"], "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```terminal\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```terminal\n nx migrate next\n```\n\nUpdate @nrwl/workspace to \"9.0.0\". This will update other packages and will generate migrations.json:\n\n```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```terminal\n nx 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```shell\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```shell\n nx migrate next\n```\n\nUpdate @nrwl/workspace to \"9.0.0\". This will update other packages and will generate migrations.json:\n\n```shell\n nx 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```shell\n nx 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```shell\n nx 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```shell\n nx 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```shell\n nx 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```shell\n nx 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" }, { "name": "report", "id": "report", "file": "generated/cli/report", - "content": "---\ntitle: 'report - CLI command'\ndescription: 'Reports useful version numbers to copy into the Nx issue template'\n---\n\n# report\n\nReports useful version numbers to copy into the Nx issue template\n\n## Usage\n\n```terminal\nnx report\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" + "content": "---\ntitle: 'report - CLI command'\ndescription: 'Reports useful version numbers to copy into the Nx issue template'\n---\n\n# report\n\nReports useful version numbers to copy into the Nx issue template\n\n## Usage\n\n```shell\nnx report\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" }, { "name": "list", "id": "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```terminal\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```terminal\n nx 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```terminal\n nx 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```shell\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```shell\n nx 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```shell\n nx 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" }, { "name": "workspace-lint", "id": "workspace-lint", "tags": ["enforce-project-boundaries"], "file": "generated/cli/workspace-lint", - "content": "---\ntitle: 'workspace-lint - CLI command'\ndescription: 'Lint nx specific workspace files (nx.json, workspace.json)'\n---\n\n# workspace-lint\n\nLint nx specific workspace files (nx.json, workspace.json)\n\n## Usage\n\n```terminal\nnx workspace-lint [files..]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" + "content": "---\ntitle: 'workspace-lint - CLI command'\ndescription: 'Lint nx specific workspace files (nx.json, workspace.json)'\n---\n\n# workspace-lint\n\nLint nx specific workspace files (nx.json, workspace.json)\n\n## Usage\n\n```shell\nnx workspace-lint [files..]\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" }, { "name": "workspace-generator", "id": "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```terminal\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```shell\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", "id": "connect-to-nx-cloud", "tags": ["cache-task-results", "distribute-task-execution"], "file": "generated/cli/connect", - "content": "---\ntitle: 'connect - CLI command'\ndescription: 'Connect workspace to Nx Cloud'\n---\n\n# connect\n\nConnect workspace to Nx Cloud\n\n## Usage\n\n```terminal\nnx connect\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 - CLI command'\ndescription: 'Connect workspace to Nx Cloud'\n---\n\n# connect\n\nConnect workspace to Nx Cloud\n\n## Usage\n\n```shell\nnx connect\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", "id": "reset", "tags": ["cache-task-results"], "file": "generated/cli/reset", - "content": "---\ntitle: 'reset - CLI command'\ndescription: 'Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.'\n---\n\n# reset\n\nClears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.\n\n## Usage\n\n```terminal\nnx reset\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" + "content": "---\ntitle: 'reset - CLI command'\ndescription: 'Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.'\n---\n\n# reset\n\nClears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.\n\n## Usage\n\n```shell\nnx reset\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n" }, { "name": "repair", "id": "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```terminal\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```shell\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" }, { "name": "exec", "id": "exec", "file": "generated/cli/exec", - "content": "---\ntitle: 'exec - CLI command'\ndescription: 'Executes any command as if it was a target on the project'\n---\n\n# exec\n\nExecutes any command as if it was a target on the project\n\n## Usage\n\n```terminal\nnx exec\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### 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### 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, compact]\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### project\n\nType: `string`\n\nTarget project\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### 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: 'exec - CLI command'\ndescription: 'Executes any command as if it was a target on the project'\n---\n\n# exec\n\nExecutes any command as if it was a target on the project\n\n## Usage\n\n```shell\nnx exec\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### 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### 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, compact]\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### project\n\nType: `string`\n\nTarget project\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### 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": "watch", "id": "watch", "tags": ["workspace-watching"], "file": "generated/cli/watch", - "content": "---\ntitle: 'watch - CLI command'\ndescription: 'Watch for changes within projects, and execute commands'\n---\n\n# watch\n\nWatch for changes within projects, and execute commands\n\n## Usage\n\n```terminal\nnx watch\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\nWatch the \"app\" project and echo the project name and the files that changed:\n\n```terminal\n nx watch --projects=app -- echo \\$NX_PROJECT_NAME \\$NX_FILE_CHANGES\n```\n\nWatch \"app1\" and \"app2\" and echo the project name whenever a specified project or its dependencies change:\n\n```terminal\n nx watch --projects=app1,app2 --includeDependencies -- echo \\$NX_PROJECT_NAME\n```\n\nWatch all projects (including newly created projects) in the workspace:\n\n```terminal\n nx watch --all -- echo \\$NX_PROJECT_NAME\n```\n\n## Options\n\n### all\n\nType: `boolean`\n\nWatch all projects.\n\n### help\n\nType: `boolean`\n\nShow help\n\n### includeDependentProjects\n\nType: `boolean`\n\nWhen watching selected projects, include dependent projects as well.\n\n### projects\n\nType: `string`\n\nProjects to watch (comma delimited).\n\n### verbose\n\nType: `boolean`\n\nRun watch mode in verbose mode, where commands are logged before execution.\n\n### version\n\nType: `boolean`\n\nShow version number\n" + "content": "---\ntitle: 'watch - CLI command'\ndescription: 'Watch for changes within projects, and execute commands'\n---\n\n# watch\n\nWatch for changes within projects, and execute commands\n\n## Usage\n\n```shell\nnx watch\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\nWatch the \"app\" project and echo the project name and the files that changed:\n\n```shell\n nx watch --projects=app -- echo \\$NX_PROJECT_NAME \\$NX_FILE_CHANGES\n```\n\nWatch \"app1\" and \"app2\" and echo the project name whenever a specified project or its dependencies change:\n\n```shell\n nx watch --projects=app1,app2 --includeDependencies -- echo \\$NX_PROJECT_NAME\n```\n\nWatch all projects (including newly created projects) in the workspace:\n\n```shell\n nx watch --all -- echo \\$NX_PROJECT_NAME\n```\n\n## Options\n\n### all\n\nType: `boolean`\n\nWatch all projects.\n\n### help\n\nType: `boolean`\n\nShow help\n\n### includeDependentProjects\n\nType: `boolean`\n\nWhen watching selected projects, include dependent projects as well.\n\n### projects\n\nType: `string`\n\nProjects to watch (comma delimited).\n\n### verbose\n\nType: `boolean`\n\nRun watch mode in verbose mode, where commands are logged before execution.\n\n### version\n\nType: `boolean`\n\nShow version number\n" } ], "generators": [], diff --git a/scripts/documentation/generate-cli-data.ts b/scripts/documentation/generate-cli-data.ts index 6ac1d68e555ab..db6488cf5645a 100644 --- a/scripts/documentation/generate-cli-data.ts +++ b/scripts/documentation/generate-cli-data.ts @@ -51,7 +51,7 @@ ${formatDeprecated(command.description, command.deprecated)} ## Usage -\`\`\`terminal +\`\`\`shell nx ${command.commandString} \`\`\` @@ -60,7 +60,7 @@ Install \`nx\` globally to invoke the command directly using \`nx\`, or use \`np if (examples[command.name] && examples[command.name].length > 0) { template += `\n### Examples\n`; examples[command.name].forEach((example) => { - template += `${example.description}:\n\`\`\`terminal\n nx ${example.command}\n\`\`\`\n`; + template += `${example.description}:\n\`\`\`shell\n nx ${example.command}\n\`\`\`\n`; }); }