diff --git a/docs/generated/cli/affected-apps.md b/docs/generated/cli/affected-apps.md index 7fcc775f57..39948cfcbb 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 -```bash +```terminal nx affected:apps ``` @@ -21,14 +21,21 @@ 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: -````bash - nx affected:apps --files=libs/mylib/src/index.ts``` +```terminal + 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): -```bash - nx affected:apps --base=main --head=HEAD``` + +```terminal + nx affected:apps --base=main --head=HEAD +``` + Print the names of all the apps affected by the last commit on main: -```bash - nx affected:apps --base=main~1 --head=main``` + +```terminal + nx affected:apps --base=main~1 --head=main +``` ## Options @@ -37,16 +44,19 @@ Print the names of all the apps affected by the last commit on main: Type: `boolean` All projects + ### base Type: `string` Base of the current branch (usually main) + ### configuration Type: `string` This is the configuration to use when performing tasks on projects + ### exclude Type: `array` @@ -54,21 +64,25 @@ Type: `array` Default: `[]` Exclude certain projects from being processed + ### files Type: `array` Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas + ### head Type: `string` Latest commit of the current branch (usually HEAD) + ### help Type: `boolean` Show help + ### nx-bail Type: `boolean` @@ -76,6 +90,7 @@ Type: `boolean` Default: `false` Stop command execution after the first failed task + ### nx-ignore-cycles Type: `boolean` @@ -83,14 +98,17 @@ Type: `boolean` Default: `false` Ignore cycles in the task graph + ### plain Produces a plain output for affected:apps and affected:libs + ### runner Type: `string` This is the name of the tasks runner configured in nx.json + ### skip-nx-cache Type: `boolean` @@ -98,16 +116,19 @@ Type: `boolean` Default: `false` Rerun the tasks even when the results are available in the cache + ### uncommitted Type: `boolean` Uncommitted changes + ### untracked Type: `boolean` Untracked changes + ### verbose Type: `boolean` @@ -115,9 +136,9 @@ Type: `boolean` Default: `false` Prints additional information about the commands (e.g., stack traces) + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/affected-graph.md b/docs/generated/cli/affected-graph.md index b0fa54d0b3..25c1cf7645 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 -```bash +```terminal nx affected:graph ``` @@ -19,23 +19,39 @@ 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: -````bash - nx affected:graph --files=libs/mylib/src/index.ts``` +```terminal + nx affected:graph --files=libs/mylib/src/index.ts +``` + Open the project graph of the workspace in the browser, and highlight the projects affected by the changes between main and HEAD (e.g., PR): -```bash - nx affected:graph --base=main --head=HEAD``` + +```terminal + nx affected:graph --base=main --head=HEAD +``` + Save the project graph of the workspace in a json file, and highlight the projects affected by the changes between main and HEAD (e.g., PR): -```bash - nx affected:graph --base=main --head=HEAD --file=output.json``` + +```terminal + nx affected:graph --base=main --head=HEAD --file=output.json +``` + Generate a static website with project graph data in an html file, highlighting the projects affected by the changes between main and HEAD (e.g., PR): -```bash - nx affected:graph --base=main --head=HEAD --file=output.html``` + +```terminal + nx affected:graph --base=main --head=HEAD --file=output.html +``` + Open the project graph of the workspace in the browser, and highlight the projects affected by the last commit on main: -```bash - nx affected:graph --base=main~1 --head=main``` + +```terminal + nx affected:graph --base=main~1 --head=main +``` + Open the project graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two: -```bash - nx affected:graph --exclude=project-one,project-two``` + +```terminal + nx affected:graph --exclude=project-one,project-two +``` ## Options @@ -44,16 +60,19 @@ Open the project graph of the workspace in the browser, highlight the projects a Type: `boolean` All projects + ### base Type: `string` Base of the current branch (usually main) + ### configuration Type: `string` This is the configuration to use when performing tasks on projects + ### exclude Type: `array` @@ -61,41 +80,49 @@ Type: `array` Default: `[]` Exclude certain projects from being processed + ### file Type: `string` Output file (e.g. --file=output.json or --file=dep-graph.html) + ### files Type: `array` Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas + ### focus Type: `string` Use to show the project graph for a particular project and every node that is either an ancestor or a descendant. + ### groupByFolder Type: `boolean` Group projects by folder in the project graph + ### head Type: `string` Latest commit of the current branch (usually HEAD) + ### help Type: `boolean` Show help + ### host Type: `string` Bind the project graph server to a specific ip address. + ### nx-bail Type: `boolean` @@ -103,6 +130,7 @@ Type: `boolean` Default: `false` Stop command execution after the first failed task + ### nx-ignore-cycles Type: `boolean` @@ -110,6 +138,7 @@ Type: `boolean` Default: `false` Ignore cycles in the task graph + ### open Type: `boolean` @@ -117,16 +146,19 @@ Type: `boolean` Default: `true` Open the project graph in the browser. + ### port Type: `number` Bind the project graph server to a specific port. + ### runner Type: `string` This is the name of the tasks runner configured in nx.json + ### skip-nx-cache Type: `boolean` @@ -134,16 +166,19 @@ Type: `boolean` Default: `false` Rerun the tasks even when the results are available in the cache + ### uncommitted Type: `boolean` Uncommitted changes + ### untracked Type: `boolean` Untracked changes + ### verbose Type: `boolean` @@ -151,11 +186,13 @@ Type: `boolean` Default: `false` Prints additional information about the commands (e.g., stack traces) + ### version Type: `boolean` Show version number + ### watch Type: `boolean` @@ -163,4 +200,3 @@ Type: `boolean` Default: `false` Watch for changes to project graph and update in-browser -```` diff --git a/docs/generated/cli/affected-libs.md b/docs/generated/cli/affected-libs.md index f9579476ea..19fb106619 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 -```bash +```terminal nx affected:libs ``` @@ -21,14 +21,21 @@ 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: -````bash - nx affected:libs --files=libs/mylib/src/index.ts``` +```terminal + 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): -```bash - nx affected:libs --base=main --head=HEAD``` + +```terminal + nx affected:libs --base=main --head=HEAD +``` + Print the names of all the libs affected by the last commit on main: -```bash - nx affected:libs --base=main~1 --head=main``` + +```terminal + nx affected:libs --base=main~1 --head=main +``` ## Options @@ -37,16 +44,19 @@ Print the names of all the libs affected by the last commit on main: Type: `boolean` All projects + ### base Type: `string` Base of the current branch (usually main) + ### configuration Type: `string` This is the configuration to use when performing tasks on projects + ### exclude Type: `array` @@ -54,21 +64,25 @@ Type: `array` Default: `[]` Exclude certain projects from being processed + ### files Type: `array` Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas + ### head Type: `string` Latest commit of the current branch (usually HEAD) + ### help Type: `boolean` Show help + ### nx-bail Type: `boolean` @@ -76,6 +90,7 @@ Type: `boolean` Default: `false` Stop command execution after the first failed task + ### nx-ignore-cycles Type: `boolean` @@ -83,14 +98,17 @@ Type: `boolean` Default: `false` Ignore cycles in the task graph + ### plain Produces a plain output for affected:apps and affected:libs + ### runner Type: `string` This is the name of the tasks runner configured in nx.json + ### skip-nx-cache Type: `boolean` @@ -98,16 +116,19 @@ Type: `boolean` Default: `false` Rerun the tasks even when the results are available in the cache + ### uncommitted Type: `boolean` Uncommitted changes + ### untracked Type: `boolean` Untracked changes + ### verbose Type: `boolean` @@ -115,9 +136,9 @@ Type: `boolean` Default: `false` Prints additional information about the commands (e.g., stack traces) + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md index a7be1b869d..e539ab26d7 100644 --- a/docs/generated/cli/affected.md +++ b/docs/generated/cli/affected.md @@ -9,7 +9,7 @@ Run target for affected projects ## Usage -```bash +```terminal nx affected ``` @@ -19,23 +19,39 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Run custom target for all affected projects: -````bash - nx affected --target=custom-target``` +```terminal + nx affected --target=custom-target +``` + Run tests in parallel: -```bash - nx affected --target=test --parallel=5``` + +```terminal + nx affected --target=test --parallel=5 +``` + Run the test target for all projects: -```bash - nx affected --target=test --all``` + +```terminal + nx affected --target=test --all +``` + Run tests for all the projects affected by changing the index.ts file: -```bash - nx affected --target=test --files=libs/mylib/src/index.ts``` + +```terminal + 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): -```bash - nx affected --target=test --base=main --head=HEAD``` + +```terminal + nx affected --target=test --base=main --head=HEAD +``` + Run tests for all the projects affected by the last commit on main: -```bash - nx affected --target=test --base=main~1 --head=main``` + +```terminal + nx affected --target=test --base=main~1 --head=main +``` ## Options @@ -44,16 +60,19 @@ Run tests for all the projects affected by the last commit on main: Type: `boolean` All projects + ### base Type: `string` Base of the current branch (usually main) + ### configuration Type: `string` This is the configuration to use when performing tasks on projects + ### exclude Type: `array` @@ -61,21 +80,25 @@ Type: `array` Default: `[]` Exclude certain projects from being processed + ### files Type: `array` Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas + ### head Type: `string` Latest commit of the current branch (usually HEAD) + ### help Type: `boolean` Show help + ### nx-bail Type: `boolean` @@ -83,6 +106,7 @@ Type: `boolean` Default: `false` Stop command execution after the first failed task + ### nx-ignore-cycles Type: `boolean` @@ -90,6 +114,7 @@ Type: `boolean` Default: `false` Ignore cycles in the task graph + ### output-style Type: `string` @@ -97,16 +122,19 @@ Type: `string` Choices: [dynamic, static, stream, stream-without-prefixes] Defines how Nx emits outputs tasks logs + ### parallel Type: `string` Max number of parallel processes [default is 3] + ### runner Type: `string` This is the name of the tasks runner configured in nx.json + ### skip-nx-cache Type: `boolean` @@ -114,21 +142,25 @@ Type: `boolean` Default: `false` Rerun the tasks even when the results are available in the cache + ### target Type: `string` Task to run for affected projects + ### uncommitted Type: `boolean` Uncommitted changes + ### untracked Type: `boolean` Untracked changes + ### verbose Type: `boolean` @@ -136,9 +168,9 @@ Type: `boolean` Default: `false` Prints additional information about the commands (e.g., stack traces) + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/connect-to-nx-cloud.md b/docs/generated/cli/connect-to-nx-cloud.md index 0d5749cca1..83bef8b0f7 100644 --- a/docs/generated/cli/connect-to-nx-cloud.md +++ b/docs/generated/cli/connect-to-nx-cloud.md @@ -9,7 +9,7 @@ Makes sure the workspace is connected to Nx Cloud ## Usage -```bash +```terminal nx connect-to-nx-cloud ``` diff --git a/docs/generated/cli/daemon.md b/docs/generated/cli/daemon.md index c6aa4aad3d..100d2aba40 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 -```bash +```terminal nx daemon ``` diff --git a/docs/generated/cli/format-check.md b/docs/generated/cli/format-check.md index 6f59b793e3..f59a764497 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 -```bash +```terminal nx format:check ``` diff --git a/docs/generated/cli/format-write.md b/docs/generated/cli/format-write.md index d77b744522..9ee38c5a86 100644 --- a/docs/generated/cli/format-write.md +++ b/docs/generated/cli/format-write.md @@ -9,7 +9,7 @@ Overwrite un-formatted files ## Usage -```bash +```terminal nx format:write ``` diff --git a/docs/generated/cli/graph.md b/docs/generated/cli/graph.md index 4ce5bfeb46..c88de23efe 100644 --- a/docs/generated/cli/graph.md +++ b/docs/generated/cli/graph.md @@ -9,7 +9,7 @@ Graph dependencies within workspace ## Usage -```bash +```terminal nx graph ``` @@ -19,29 +19,51 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Open the project graph of the workspace in the browser: -````bash - nx graph``` +```terminal + nx graph +``` + Save the project graph into a json file: -```bash - nx graph --file=output.json``` + +```terminal + nx graph --file=output.json +``` + Generate a static website with project graph into an html file, accompanied by an asset folder called static: -```bash - nx graph --file=output.html``` + +```terminal + nx graph --file=output.html +``` + Show the graph where every node is either an ancestor or a descendant of todos-feature-main: -```bash - nx graph --focus=todos-feature-main``` + +```terminal + nx graph --focus=todos-feature-main +``` + Include project-one and project-two in the project graph: -```bash - nx graph --include=project-one,project-two``` + +```terminal + nx graph --include=project-one,project-two +``` + Exclude project-one and project-two from the project graph: -```bash - nx graph --exclude=project-one,project-two``` + +```terminal + 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: -```bash - nx graph --focus=todos-feature-main --exclude=project-one,project-two``` + +```terminal + nx graph --focus=todos-feature-main --exclude=project-one,project-two +``` + Watch for changes to project graph and update in-browser: -```bash - nx graph --watch``` + +```terminal + nx graph --watch +``` ## Options @@ -50,31 +72,37 @@ Watch for changes to project graph and update in-browser: Type: `array` List of projects delimited by commas to exclude from the project graph. + ### file Type: `string` Output file (e.g. --file=output.json or --file=dep-graph.html) + ### focus Type: `string` Use to show the project graph for a particular project and every node that is either an ancestor or a descendant. + ### groupByFolder Type: `boolean` Group projects by folder in the project graph + ### help Type: `boolean` Show help + ### host Type: `string` Bind the project graph server to a specific ip address. + ### open Type: `boolean` @@ -82,16 +110,19 @@ Type: `boolean` Default: `true` Open the project graph in the browser. + ### port Type: `number` Bind the project graph server to a specific port. + ### version Type: `boolean` Show version number + ### watch Type: `boolean` @@ -99,4 +130,3 @@ Type: `boolean` Default: `false` Watch for changes to project graph and update in-browser -```` diff --git a/docs/generated/cli/init.md b/docs/generated/cli/init.md index d778786650..e3980a0bc9 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 -```bash +```terminal nx init ``` diff --git a/docs/generated/cli/list.md b/docs/generated/cli/list.md index 53b3e1fdfd..613f69ade9 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 -```bash +```terminal nx list [plugin] ``` @@ -19,11 +19,15 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` List the plugins installed in the current workspace: -````bash - nx list``` +```terminal + 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): -```bash - nx list @nrwl/web``` + +```terminal + nx list @nrwl/web +``` ## Options @@ -32,14 +36,15 @@ List the generators and executors available in the `@nrwl/web` plugin if it is i Type: `boolean` Show help + ### plugin Type: `string` The name of an installed plugin to query + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/migrate.md b/docs/generated/cli/migrate.md index 9fff3a128c..351b3b8d0e 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 -```bash +```terminal nx migrate [packageAndVersion] ``` @@ -25,26 +25,45 @@ 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: -````bash - nx migrate next``` +```terminal + nx migrate next +``` + Update @nrwl/workspace to "9.0.0". This will update other packages and will generate migrations.json: -```bash - nx migrate 9.0.0``` + +```terminal + 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: -```bash - nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0"``` + +```terminal + 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": -```bash - nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1"``` + +```terminal + 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: -```bash - nx migrate another-package@12.0.0``` + +```terminal + 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: -```bash - nx migrate --run-migrations=migrations.json``` + +```terminal + 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 ": -```bash - nx migrate --run-migrations --create-commits``` + +```terminal + nx migrate --run-migrations --create-commits +``` ## Options @@ -55,6 +74,7 @@ Type: `string` Default: `chore: [nx migration] ` Commit prefix to apply to the commit for each migration, when --create-commits is enabled + ### createCommits Type: `boolean` @@ -62,34 +82,39 @@ Type: `boolean` Default: `false` Automatically create a git commit after each migration runs + ### from 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") + ### help Type: `boolean` Show help + ### packageAndVersion Type: `string` The target package and version (e.g, @nrwl/workspace@13.0.0) + ### runMigrations Type: `string` Execute migrations from a file (when the file isn't provided, execute migrations from migrations.json) + ### to 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") + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/print-affected.md b/docs/generated/cli/print-affected.md index f40b9bfa8c..ef68341af5 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 -```bash +```terminal nx print-affected ``` @@ -19,20 +19,33 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Print information about affected projects and the project graph: -````bash - nx print-affected``` +```terminal + nx print-affected +``` + Print information about the projects affected by the changes between main and HEAD (e.g,. PR): -```bash - nx print-affected --base=main --head=HEAD``` + +```terminal + nx print-affected --base=main --head=HEAD +``` + Prints information about the affected projects and a list of tasks to test them: -```bash - nx print-affected --target=test``` + +```terminal + nx print-affected --target=test +``` + Prints the projects property from the print-affected output: -```bash - nx print-affected --target=build --select=projects``` + +```terminal + nx print-affected --target=build --select=projects +``` + Prints the tasks.target.project property from the print-affected output: -```bash - nx print-affected --target=build --select=tasks.target.project``` + +```terminal + nx print-affected --target=build --select=tasks.target.project +``` ## Options @@ -41,16 +54,19 @@ Prints the tasks.target.project property from the print-affected output: Type: `boolean` All projects + ### base Type: `string` Base of the current branch (usually main) + ### configuration Type: `string` This is the configuration to use when performing tasks on projects + ### exclude Type: `array` @@ -58,21 +74,25 @@ Type: `array` Default: `[]` Exclude certain projects from being processed + ### files Type: `array` Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas + ### head Type: `string` Latest commit of the current branch (usually HEAD) + ### help Type: `boolean` Show help + ### nx-bail Type: `boolean` @@ -80,6 +100,7 @@ Type: `boolean` Default: `false` Stop command execution after the first failed task + ### nx-ignore-cycles Type: `boolean` @@ -87,16 +108,19 @@ Type: `boolean` Default: `false` Ignore cycles in the task graph + ### runner Type: `string` This is the name of the tasks runner configured in nx.json + ### select Type: `string` Select the subset of the returned json document (e.g., --select=projects) + ### skip-nx-cache Type: `boolean` @@ -104,6 +128,7 @@ Type: `boolean` Default: `false` Rerun the tasks even when the results are available in the cache + ### type Type: `string` @@ -111,16 +136,19 @@ Type: `string` Choices: [app, lib] Select the type of projects to be returned (e.g., --type=app) + ### uncommitted Type: `boolean` Uncommitted changes + ### untracked Type: `boolean` Untracked changes + ### verbose Type: `boolean` @@ -128,9 +156,9 @@ Type: `boolean` Default: `false` Prints additional information about the commands (e.g., stack traces) + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/repair.md b/docs/generated/cli/repair.md index 403ce18bb6..c560215a28 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 -```bash +```terminal nx repair ``` diff --git a/docs/generated/cli/report.md b/docs/generated/cli/report.md index 42e189fd72..8b9c93cbd9 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 -```bash +```terminal nx report ``` diff --git a/docs/generated/cli/reset.md b/docs/generated/cli/reset.md index 4789725351..bdc1226806 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 -```bash +```terminal nx reset ``` diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md index ec235859b6..1c11ba1567 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 -```bash +```terminal nx run-many ``` @@ -19,14 +19,21 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx` Test all projects: -````bash - nx run-many --target=test``` +```terminal + nx run-many --target=test +``` + Test proj1 and proj2: -```bash - nx run-many --target=test --projects=proj1,proj2``` + +```terminal + nx run-many --target=test --projects=proj1,proj2 +``` + Test proj1 and proj2 in parallel: -```bash - nx run-many --target=test --projects=proj1,proj2 --parallel=2``` + +```terminal + nx run-many --target=test --projects=proj1,proj2 --parallel=2 +``` ## Options @@ -37,11 +44,13 @@ Type: `boolean` Default: `true` [deprecated] Run the target on all projects in the workspace + ### configuration Type: `string` This is the configuration to use when performing tasks on projects + ### exclude Type: `array` @@ -49,11 +58,13 @@ Type: `array` Default: `[]` Exclude certain projects from being processed + ### help Type: `boolean` Show help + ### nx-bail Type: `boolean` @@ -61,6 +72,7 @@ Type: `boolean` Default: `false` Stop command execution after the first failed task + ### nx-ignore-cycles Type: `boolean` @@ -68,6 +80,7 @@ Type: `boolean` Default: `false` Ignore cycles in the task graph + ### output-style Type: `string` @@ -75,21 +88,25 @@ Type: `string` Choices: [dynamic, static, stream, stream-without-prefixes] Defines how Nx emits outputs tasks logs + ### parallel Type: `string` Max number of parallel processes [default is 3] + ### projects Type: `string` Projects to run (comma delimited) + ### runner Type: `string` Override the tasks runner in `nx.json` + ### skip-nx-cache Type: `boolean` @@ -97,11 +114,13 @@ Type: `boolean` Default: `false` Rerun the tasks even when the results are available in the cache + ### target Type: `string` Task to run for affected projects + ### verbose Type: `boolean` @@ -109,9 +128,9 @@ Type: `boolean` Default: `false` Prints additional information about the commands (e.g., stack traces) + ### version Type: `boolean` Show version number -```` diff --git a/docs/generated/cli/workspace-generator.md b/docs/generated/cli/workspace-generator.md index 8132715bc3..c602609d31 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 -```bash +```terminal nx workspace-generator [name] ``` diff --git a/docs/generated/cli/workspace-lint.md b/docs/generated/cli/workspace-lint.md index 1d0a91574e..c5bc40d3a8 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 -```bash +```terminal nx workspace-lint [files..] ``` diff --git a/docs/generated/packages/nx.json b/docs/generated/packages/nx.json index 8ff578671b..900df8932b 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```bash\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```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" }, { "name": "generate", @@ -36,118 +36,118 @@ "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```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```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" }, { "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```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" + "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" }, { "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```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" + "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\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" }, { "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```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" + "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\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```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" + "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### 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" }, { "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```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" + "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### 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" }, { "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```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" + "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### 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" }, { "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```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" + "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### 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" }, { "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```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```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### 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", "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```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```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### 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", "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```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" + "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" }, { "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```bash\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```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" }, { "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```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" + "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" }, { "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```bash\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```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" }, { "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```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```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" }, { "name": "connect-to-nx-cloud", "id": "connect-to-nx-cloud", "tags": ["cache-task-results", "distribute-task-execution"], "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```terminal\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", "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```bash\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```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" }, { "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```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```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" } ], "generators": [], diff --git a/scripts/documentation/generate-cli-data.ts b/scripts/documentation/generate-cli-data.ts index f30ef3a8d4..6ac1d68e55 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 -\`\`\`bash +\`\`\`terminal 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\`\`\`bash\n nx ${example.command}\`\`\`\n`; + template += `${example.description}:\n\`\`\`terminal\n nx ${example.command}\n\`\`\`\n`; }); }