{
"name": "nx",
"description": "Fig completions for Nx by Nrwl",
"subcommands": [
{
"name": "init",
"description": "Adds nx.json file and installs nx if not installed already",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "generate",
"description": "Runs a generator that creates and/or modifies files based on a generator from a collection",
"options": [
{
"names": [
"--defaults"
],
"description": "When true, disables interactive input prompts for options with a default"
},
{
"names": [
"--dryRun"
],
"description": "When true, preview the changes without updating files"
},
{
"names": [
"--force"
],
"description": "When true, forces overwriting of existing files"
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--interactive"
],
"description": "Enable/disable prompts"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
],
"args": [
{
"name": "collection:generator"
}
]
},
{
"name": "run",
"description": "Runs an Architect target with an optional custom builder configuration defined in your project",
"options": [
{
"names": [
"--configuration",
"-c"
],
"description": "A named builder configuration, defined in the \"configurations\" section of the workspace configuration file. The builder uses the named configuration to run the given target",
"takes_arg": true,
"arg": {
"name": "configuration"
}
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
],
"args": [
{
"name": "project:target[:configuration]"
}
]
},
{
"name": "daemon",
"description": "Prints information about the Nx Daemon process or starts a daemon process",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--start"
]
},
{
"names": [
"--stop"
]
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "graph",
"description": "Graph dependencies within workspace",
"options": [
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--file"
],
"description": "Output file (e.g. --file=output.json or --file=dep-graph.html)",
"takes_arg": true
},
{
"names": [
"--focus"
],
"description": "Use to show the project graph for a particular project and every node that is either an ancestor or a descendant",
"takes_arg": true,
"arg": {
"name": "project"
}
},
{
"names": [
"--groupByFolder"
],
"description": "Group projects by folder in the project graph"
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--host"
],
"description": "Bind the project graph server to a specific ip address",
"takes_arg": true
},
{
"names": [
"--open"
],
"description": "Open the project graph in the browser"
},
{
"names": [
"--port"
],
"description": "Bind the project graph server to a specific port",
"takes_arg": true
},
{
"names": [
"--targets"
],
"description": "Targets (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "targets"
}
},
{
"names": [
"--version"
],
"description": "Show version number"
},
{
"names": [
"--view"
],
"description": "Choose whether to view the projects or task graph",
"takes_arg": true,
"arg": {
"suggestions": [
"projects",
"tasks"
]
}
},
{
"names": [
"--watch"
],
"description": "Watch for changes to project graph and update in-browser"
}
]
},
{
"name": "run-many",
"description": "Run target for multiple listed projects",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--configuration",
"-c"
],
"description": "A named builder configuration, defined in the \"configurations\" section of the workspace configuration file. The builder uses the named configuration to run the given target",
"takes_arg": true,
"arg": {
"name": "configuration"
}
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--graph"
],
"description": "Show the task graph of the command"
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--nx-bail"
],
"description": "Stop command execution after the first failed task"
},
{
"names": [
"--nx-ignore-cycles"
],
"description": "Ignore cycles in the task graph"
},
{
"names": [
"--output-style"
],
"description": "Defines how Nx emits outputs tasks logs",
"takes_arg": true,
"arg": {
"suggestions": [
"dynamic",
"static",
"stream",
"stream-without-prefixes",
"compact"
]
}
},
{
"names": [
"--parallel"
],
"description": "Max number of parallel processes [default is 3]",
"takes_arg": true
},
{
"names": [
"--projects"
],
"description": "Projects (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--runner"
],
"description": "This is the name of the tasks runner configured in nx.json",
"takes_arg": true
},
{
"names": [
"--skip-nx-cache"
],
"description": "Rerun the tasks even when the results are available in the cache"
},
{
"names": [
"--targets"
],
"description": "Targets (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "targets"
}
},
{
"names": [
"--verbose"
],
"description": "Prints additional information about the commands (e.g., stack traces)"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "affected",
"description": "Run target for affected projects",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--base"
],
"description": "Base of the current branch (usually main)",
"takes_arg": true
},
{
"names": [
"--configuration",
"-c"
],
"description": "A named builder configuration, defined in the \"configurations\" section of the workspace configuration file. The builder uses the named configuration to run the given target",
"takes_arg": true,
"arg": {
"name": "configuration"
}
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--files"
],
"description": "Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces",
"takes_arg": true
},
{
"names": [
"--graph"
],
"description": "Show the task graph of the command"
},
{
"names": [
"--head"
],
"description": "Latest commit of the current branch (usually HEAD)",
"takes_arg": true
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--nx-bail"
],
"description": "Stop command execution after the first failed task"
},
{
"names": [
"--nx-ignore-cycles"
],
"description": "Ignore cycles in the task graph"
},
{
"names": [
"--output-style"
],
"description": "Defines how Nx emits outputs tasks logs",
"takes_arg": true,
"arg": {
"suggestions": [
"dynamic",
"static",
"stream",
"stream-without-prefixes",
"compact"
]
}
},
{
"names": [
"--parallel"
],
"description": "Max number of parallel processes [default is 3]",
"takes_arg": true
},
{
"names": [
"--runner"
],
"description": "This is the name of the tasks runner configured in nx.json",
"takes_arg": true
},
{
"names": [
"--skip-nx-cache"
],
"description": "Rerun the tasks even when the results are available in the cache"
},
{
"names": [
"--targets"
],
"description": "Targets (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "targets"
}
},
{
"names": [
"--uncommitted"
],
"description": "Uncommitted changes"
},
{
"names": [
"--untracked"
],
"description": "Untracked changes"
},
{
"names": [
"--verbose"
],
"description": "Prints additional information about the commands (e.g., stack traces)"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "affected:graph",
"description": "Graph dependencies affected by changes",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--base"
],
"description": "Base of the current branch (usually main)",
"takes_arg": true
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--file"
],
"description": "Output file (e.g. --file=output.json or --file=dep-graph.html)",
"takes_arg": true
},
{
"names": [
"--files"
],
"description": "Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces",
"takes_arg": true
},
{
"names": [
"--focus"
],
"description": "Use to show the project graph for a particular project and every node that is either an ancestor or a descendant",
"takes_arg": true,
"arg": {
"name": "project"
}
},
{
"names": [
"--groupByFolder"
],
"description": "Group projects by folder in the project graph"
},
{
"names": [
"--head"
],
"description": "Latest commit of the current branch (usually HEAD)",
"takes_arg": true
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--host"
],
"description": "Bind the project graph server to a specific ip address",
"takes_arg": true
},
{
"names": [
"--open"
],
"description": "Open the project graph in the browser"
},
{
"names": [
"--port"
],
"description": "Bind the project graph server to a specific port",
"takes_arg": true
},
{
"names": [
"--targets"
],
"description": "Targets (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "targets"
}
},
{
"names": [
"--uncommitted"
],
"description": "Uncommitted changes"
},
{
"names": [
"--untracked"
],
"description": "Untracked changes"
},
{
"names": [
"--version"
],
"description": "Show version number"
},
{
"names": [
"--view"
],
"description": "Choose whether to view the projects or task graph",
"takes_arg": true,
"arg": {
"suggestions": [
"projects",
"tasks"
]
}
},
{
"names": [
"--watch"
],
"description": "Watch for changes to project graph and update in-browser"
}
]
},
{
"name": "print-affected",
"description": "Prints information about the projects and targets affected by changes",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--base"
],
"description": "Base of the current branch (usually main)",
"takes_arg": true
},
{
"names": [
"--configuration",
"-c"
],
"description": "A named builder configuration, defined in the \"configurations\" section of the workspace configuration file. The builder uses the named configuration to run the given target",
"takes_arg": true,
"arg": {
"name": "configuration"
}
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--files"
],
"description": "Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces",
"takes_arg": true
},
{
"names": [
"--head"
],
"description": "Latest commit of the current branch (usually HEAD)",
"takes_arg": true
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--select"
],
"description": "Select the subset of the returned json document (e.g., --select=projects)",
"takes_arg": true
},
{
"names": [
"--targets"
],
"description": "Targets (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "targets"
}
},
{
"names": [
"--type"
],
"description": "Select the type of projects to be returned (e.g., --type=app)",
"takes_arg": true,
"arg": {
"suggestions": [
"app",
"lib"
]
}
},
{
"names": [
"--uncommitted"
],
"description": "Uncommitted changes"
},
{
"names": [
"--untracked"
],
"description": "Untracked changes"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "format:check",
"description": "Check for un-formatted files",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--base"
],
"description": "Base of the current branch (usually main)",
"takes_arg": true
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--files"
],
"description": "Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces",
"takes_arg": true
},
{
"names": [
"--head"
],
"description": "Latest commit of the current branch (usually HEAD)",
"takes_arg": true
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--libs-and-apps"
],
"description": "Format only libraries and applications files"
},
{
"names": [
"--projects"
],
"description": "Projects (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--uncommitted"
],
"description": "Uncommitted changes"
},
{
"names": [
"--untracked"
],
"description": "Untracked changes"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "format:write",
"description": "Overwrite un-formatted files",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--base"
],
"description": "Base of the current branch (usually main)",
"takes_arg": true
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--files"
],
"description": "Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces",
"takes_arg": true
},
{
"names": [
"--head"
],
"description": "Latest commit of the current branch (usually HEAD)",
"takes_arg": true
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--libs-and-apps"
],
"description": "Format only libraries and applications files"
},
{
"names": [
"--projects"
],
"description": "Projects (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--uncommitted"
],
"description": "Uncommitted changes"
},
{
"names": [
"--untracked"
],
"description": "Untracked changes"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "migrate",
"description": "Creates a migrations file or runs migrations from the migrations file",
"options": [
{
"names": [
"--commitPrefix"
],
"description": "Commit prefix to apply to the commit for each migration, when --create-commits is enabled",
"takes_arg": true
},
{
"names": [
"--createCommits"
],
"description": "Automatically create a git commit after each migration runs"
},
{
"names": [
"--excludeAppliedMigrations"
],
"description": "Exclude migrations that should have been applied on previous updates. To be used with --from"
},
{
"names": [
"--from"
],
"description": "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\")",
"takes_arg": true
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--ifExists"
],
"description": "Run migrations only if the migrations file exists, if not continues successfully"
},
{
"names": [
"--interactive"
],
"description": "Enable/disable prompts"
},
{
"names": [
"--runMigrations"
],
"description": "Execute migrations from a file (when the file isn't provided, execute migrations from migrations.json)",
"takes_arg": true
},
{
"names": [
"--to"
],
"description": "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\")",
"takes_arg": true
},
{
"names": [
"--version"
],
"description": "Show version number"
}
],
"args": [
{
"name": "packageAndVersion",
"description": "The target package and version (e.g, @nrwl/workspace@13.0.0)",
"suggestions": [
"latest"
]
}
]
},
{
"name": "report",
"description": "Reports useful version numbers to copy into the Nx issue template",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "list",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
],
"args": [
{
"name": "plugin",
"description": "The name of an installed plugin to query"
}
]
},
{
"name": "workspace-generator",
"description": "Runs a workspace generator from the tools/generators directory",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--list-generators"
],
"description": "List the available workspace-generators"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
],
"args": [
{
"name": "name",
"description": "The name of your generator"
}
]
},
{
"name": "connect",
"description": "Connect workspace to Nx Cloud",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "reset",
"description": "Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "repair",
"description": "Repair any configuration that is no longer supported by Nx",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--verbose"
],
"description": "Prints additional information about the commands (e.g., stack traces)"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "exec",
"description": "Executes any command as if it was a target on the project",
"options": [
{
"names": [
"--configuration",
"-c"
],
"description": "A named builder configuration, defined in the \"configurations\" section of the workspace configuration file. The builder uses the named configuration to run the given target",
"takes_arg": true,
"arg": {
"name": "configuration"
}
},
{
"names": [
"--exclude"
],
"description": "Exclude certain projects from being processed",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--graph"
],
"description": "Show the task graph of the command"
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--nx-bail"
],
"description": "Stop command execution after the first failed task"
},
{
"names": [
"--nx-ignore-cycles"
],
"description": "Ignore cycles in the task graph"
},
{
"names": [
"--output-style"
],
"description": "Defines how Nx emits outputs tasks logs",
"takes_arg": true,
"arg": {
"suggestions": [
"dynamic",
"static",
"stream",
"stream-without-prefixes",
"compact"
]
}
},
{
"names": [
"--parallel"
],
"description": "Max number of parallel processes [default is 3]",
"takes_arg": true
},
{
"names": [
"--project"
],
"description": "Target project",
"takes_arg": true,
"arg": {
"name": "project"
}
},
{
"names": [
"--runner"
],
"description": "This is the name of the tasks runner configured in nx.json",
"takes_arg": true
},
{
"names": [
"--skip-nx-cache"
],
"description": "Rerun the tasks even when the results are available in the cache"
},
{
"names": [
"--verbose"
],
"description": "Prints additional information about the commands (e.g., stack traces)"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "watch",
"description": "Watch for changes within projects, and execute commands",
"options": [
{
"names": [
"--all"
],
"description": "All projects"
},
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--includeDependentProjects"
],
"description": "When watching selected projects, include dependent projects as well"
},
{
"names": [
"--projects"
],
"description": "Projects (comma/space delimited)",
"takes_arg": true,
"arg": {
"name": "projects"
}
},
{
"names": [
"--verbose"
],
"description": "Prints additional information about the commands (e.g., stack traces)"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
},
{
"name": "show",
"description": "Show information about the workspace (e.g., list of projects)",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
],
"args": [
{
"name": "object",
"description": "What to show (e.g., projects)",
"suggestions": [
"projects"
]
}
]
},
{
"name": "view-logs",
"description": "Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most r",
"options": [
{
"names": [
"--help"
],
"description": "Show help"
},
{
"names": [
"--version"
],
"description": "Show version number"
}
]
}
]
}