Adding descriptions to all args/options in CLI.

[Mitch Denny (mitchdenny)]

CLI help text pass.

aspire --help

Description:
The Aspire CLI can be used to create, run, and publish Aspire-based applications.
Usage:
aspire [command] [options]
Options:
-?, -h, --help Show help and usage information
--version Show version information
-d, --debug Enable debug logging to the console.
-w, --wait-for-debugger Wait for a debugger to attach before executing the command. [default: False]
Commands:
new <template> Create a new Aspire sample project.
run Run an Aspire app host in development mode.
add <resource> Add an integration to the Aspire project.
publish Generates deployment artifacts for an Aspire app host project.

aspire new --help

Description:
Create a new Aspire sample project.
Usage:
aspire new [<template>] [options]
Arguments:
<template> The name of the project template to use (e.g. aspire-starter, aspire).
Options:
-n, --name The name of the project to create.
-o, --output The output path for the project.
-s, --source The NuGet source to use for the project templates.
-v, --version The version of the project templates to use.
-?, -h, --help Show help and usage information
-d, --debug Enable debug logging to the console.
-w, --wait-for-debugger Wait for a debugger to attach before executing the command. [default: False]

aspire run --help

Description:
Run an Aspire app host in development mode.
Usage:
aspire run [options]
Options:
--project The path to the Aspire app host project file.
-w, --watch Start .NET project resources in watch mode.
-?, -h, --help Show help and usage information
-d, --debug Enable debug logging to the console.
-w, --wait-for-debugger Wait for a debugger to attach before executing the command. [default: False]

aspire add --help

Description:
Add an integration to the Aspire project.
Usage:
aspire add [<resource>] [options]
Arguments:
<resource> The name of the integration or resource to add (e.g. redis, postgres).
Options:
--project The path to the project file to add the integration to.
-v, --version The version of the integration to add.
--prerelease Include pre-release versions of the integration when searching.
-s, --source The NuGet source to use for the integration.
-?, -h, --help Show help and usage information
-d, --debug Enable debug logging to the console.
-w, --wait-for-debugger Wait for a debugger to attach before executing the command. [default: False]

aspire publish --help

Description:
Generates deployment artifacts for an Aspire app host project.
Usage:
aspire publish [options]
Options:
--project The path to the Aspire app host project file.
-p, --publisher The name of the publisher to use.
-o, --output-path The output path for the generated artifacts. [default: /workspaces/aspire/src/Aspire.Cli]
-?, -h, --help Show help and usage information
-d, --debug Enable debug logging to the console.
-w, --wait-for-debugger Wait for a debugger to attach before executing the command. [default: False]

[Copilot]

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

[Copilot]

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (3)

src/Aspire.Cli/Commands/RunCommand.cs:33

• The short alias '-w' for the '--watch' option may conflict with the '-w' alias used elsewhere. Consider using a unique alias for the watch option to avoid ambiguity.

watchOption.Description = "Start .NET project resources in watch mode.";

src/Aspire.Cli/Commands/RootCommand.cs:26

• The short alias '-w' for the '--wait-for-debugger' option in the root command may lead to conflicts with other commands using '-w'. Verify that the alias is unique within the command context.

waitForDebuggerOption.Description = "Wait for a debugger to attach before executing the command.";

src/Aspire.Cli/Commands/PublishCommand.cs:35

• [nitpick] Using Path.Combine with a single argument returns that argument unchanged, which could be simplified by directly specifying Environment.CurrentDirectory. This change would improve clarity of the default output path.

outputPath.DefaultValueFactory = (result) => Path.Combine(Environment.CurrentDirectory);

[Mitch Denny (mitchdenny)]

/backport to release/9.2

[github-actions]

Started backporting to release/9.2: https://github.com/dotnet/aspire/actions/runs/14259414548

[github-actions]

Mitch Denny (@mitchdenny) backporting to "release/9.2" failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: Adding descriptions to all args/options in CLI.
Using index info to reconstruct a base tree...
M	src/Aspire.Cli/Commands/NewCommand.cs
M	src/Aspire.Cli/Commands/RunCommand.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Aspire.Cli/Commands/RunCommand.cs
CONFLICT (content): Merge conflict in src/Aspire.Cli/Commands/RunCommand.cs
Auto-merging src/Aspire.Cli/Commands/NewCommand.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Adding descriptions to all args/options in CLI.
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

[Mitch Denny (mitchdenny)]

/backport to release/9.2

[github-actions]

Started backporting to release/9.2: https://github.com/dotnet/aspire/actions/runs/14260146125

[github-actions]

Mitch Denny (@mitchdenny) backporting to "release/9.2" failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: Adding descriptions to all args/options in CLI.
Using index info to reconstruct a base tree...
M	src/Aspire.Cli/Commands/NewCommand.cs
M	src/Aspire.Cli/Commands/RunCommand.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Aspire.Cli/Commands/RunCommand.cs
CONFLICT (content): Merge conflict in src/Aspire.Cli/Commands/RunCommand.cs
Auto-merging src/Aspire.Cli/Commands/NewCommand.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Adding descriptions to all args/options in CLI.
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!