Skip to content

Normalize CLI command descriptions for consistency#15204

Merged
JamesNK merged 3 commits intorelease/13.2from
davidfowl/review-commands
Mar 18, 2026
Merged

Normalize CLI command descriptions for consistency#15204
JamesNK merged 3 commits intorelease/13.2from
davidfowl/review-commands

Conversation

@davidfowl
Copy link
Contributor

@davidfowl davidfowl commented Mar 13, 2026

Description

Normalize CLI command, option, and argument descriptions for consistency and CLI best practices.

Changes

Casing normalization

  • Normalize AppHostapphost (lowercase, one word) in all user-facing CLI strings across 32+ resx files
  • Preserve AppHost casing in code identifiers (e.g. IsCompatibleAppHost), package names (Aspire.AppHost.Sdk), and template display names ("Empty AppHost")

Trailing period normalization

  • Remove trailing periods from single-sentence command/option/argument descriptions (following dotnet/git/kubectl CLI conventions)
  • Add trailing periods to multi-sentence descriptions for readability (e.g. "The path to the apphost project file. If not specified, searches for a project file in the current directory.")

Move hardcoded strings to resx

  • Move hardcoded description strings from McpCallCommand, McpToolsCommand, PipelineCommandBase, DeployCommand, InitCommand, and UpdateCommand into their corresponding resx resource files for localization consistency

Localization

  • Regenerate xlf files for all 13 languages with updated source strings

Other

  • Fix aspire export description
  • Update aspire agent description from "Manage AI agent specific setup" to "Manage AI agent environment configuration"

Files changed

  • 23 C# command files — description string references updated
  • 32 resx files — source string normalization and new entries
  • ~416 xlf files — auto-regenerated localization files
  • 15 Designer.cs files — partial updates (will fully regenerate in VS)
  • 132 test files — updated string expectations

No behavioral changes — description text only.

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
    • No
  • Does the change require an update in our Aspire docs?
    • Yes
    • No

Copilot AI review requested due to automatic review settings March 13, 2026 06:50
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15204

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15204"

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR normalizes CLI command description text in the Aspire CLI for consistency. It lowercases "AppHost" to "apphost" in user-facing command descriptions, adds a missing trailing period to the aspire export description, and updates the aspire agent description wording. All corresponding .resx, .Designer.cs, and .xlf localization files are updated.

Changes:

  • Changed "AppHost" to "apphost" (lowercase) across all CLI command descriptions in resx/Designer.cs/xlf files
  • Added missing trailing period to ExportCommandStrings.Description
  • Updated AgentCommandStrings.Description from "Manage AI agent specific setup." to "Manage AI agent environment configuration."

Reviewed changes

Copilot reviewed 168 out of 175 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
*/AgentCommandStrings.resx, .Designer.cs, *.xlf Updated agent command description wording
*/ExportCommandStrings.resx, .Designer.cs, *.xlf Added trailing period to export description
*/RunCommandStrings.resx, .Designer.cs, *.xlf Lowercased AppHost → apphost in descriptions
*/PublishCommandStrings.resx, .Designer.cs, *.xlf Lowercased AppHost → apphost in project path description
*/AddCommandStrings.resx, *.xlf Lowercased AppHost → apphost in project path description
*/UpdateCommandStrings.resx, .Designer.cs, *.xlf Lowercased AppHost → apphost in project path description
*/StopCommandStrings.resx, *.xlf Lowercased AppHost → apphost in descriptions
*/SharedCommandStrings.resx, *.xlf Lowercased AppHost → apphost in shared descriptions
*/SecretCommandStrings.resx, .Designer.cs, *.xlf Lowercased AppHost → apphost in secret command description
*/NewCommandStrings.resx, *.xlf Lowercased AppHost → apphost in language option description
*/ExecCommandStrings.resx, .Designer.cs, *.xlf Lowercased AppHost → apphost in exec command descriptions
*/RestoreCommandStrings.resx, .Designer.cs, *.xlf Lowercased AppHost → apphost in restore description
Files not reviewed (7)
  • src/Aspire.Cli/Resources/AgentCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/ExecCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/ExportCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/PublishCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/RestoreCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/SecretCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/UpdateCommandStrings.Designer.cs: Language not supported

</data>
<data name="NoInScopeAppHostsShowingAll" xml:space="preserve">
<value>No running AppHosts found in the current directory. Select from all running AppHosts.</value>
<value>No running AppHosts found in the current directory. Select from all running apphosts.</value>
Comment on lines +26 to +27
<source>No running AppHosts found in the current directory. Select from all running apphosts.</source>
<target state="new">No running AppHosts found in the current directory. Select from all running apphosts.</target>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

🎬 CLI E2E Test Recordings

The following terminal recordings are available for commit 8c5eb4a:

Test Recording
AddPackageInteractiveWhileAppHostRunningDetached ▶️ View Recording
AddPackageWhileAppHostRunningDetached ▶️ View Recording
AgentCommands_AllHelpOutputs_AreCorrect ▶️ View Recording
AgentInitCommand_DefaultSelection_InstallsSkillOnly ▶️ View Recording
AgentInitCommand_MigratesDeprecatedConfig ▶️ View Recording
AspireAddPackageVersionToDirectoryPackagesProps ▶️ View Recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps ▶️ View Recording
Banner_DisplayedOnFirstRun ▶️ View Recording
Banner_DisplayedWithExplicitFlag ▶️ View Recording
CertificatesClean_RemovesCertificates ▶️ View Recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate ▶️ View Recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate ▶️ View Recording
ConfigSetGet_CreatesNestedJsonFormat ▶️ View Recording
CreateAndDeployToDockerCompose ▶️ View Recording
CreateAndDeployToDockerComposeInteractive ▶️ View Recording
CreateAndPublishToKubernetes ▶️ View Recording
CreateAndRunAspireStarterProject ▶️ View Recording
CreateAndRunAspireStarterProjectWithBundle ▶️ View Recording
CreateAndRunEmptyAppHostProject ▶️ View Recording
CreateAndRunJsReactProject ▶️ View Recording
CreateAndRunPythonReactProject ▶️ View Recording
CreateAndRunTypeScriptEmptyAppHostProject ▶️ View Recording
CreateAndRunTypeScriptStarterProject ▶️ View Recording
CreateStartAndStopAspireProject ▶️ View Recording
CreateTypeScriptAppHostWithViteApp ▶️ View Recording
DescribeCommandResolvesReplicaNames ▶️ View Recording
DescribeCommandShowsRunningResources ▶️ View Recording
DetachFormatJsonProducesValidJson ▶️ View Recording
DoctorCommand_DetectsDeprecatedAgentConfig ▶️ View Recording
DoctorCommand_WithSslCertDir_ShowsTrusted ▶️ View Recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted ▶️ View Recording
GlobalMigration_HandlesCommentsAndTrailingCommas ▶️ View Recording
GlobalMigration_HandlesMalformedLegacyJson ▶️ View Recording
GlobalMigration_PreservesAllValueTypes ▶️ View Recording
GlobalMigration_SkipsWhenNewConfigExists ▶️ View Recording
GlobalSettings_MigratedFromLegacyFormat ▶️ View Recording
InvalidAppHostPathWithComments_IsHealedOnRun ▶️ View Recording
LogsCommandShowsResourceLogs ▶️ View Recording
PsCommandListsRunningAppHost ▶️ View Recording
PsFormatJsonOutputsOnlyJsonToStdout ❌ Upload failed
PublishWithDockerComposeServiceCallbackSucceeds ▶️ View Recording
RestoreGeneratesSdkFiles ▶️ View Recording
RunWithMissingAwaitShowsHelpfulError ▶️ View Recording
SecretCrudOnDotNetAppHost ▶️ View Recording
SecretCrudOnTypeScriptAppHost ▶️ View Recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels ▶️ View Recording
StopAllAppHostsFromAppHostDirectory ▶️ View Recording
StopAllAppHostsFromUnrelatedDirectory ▶️ View Recording
StopNonInteractiveMultipleAppHostsShowsError ▶️ View Recording
StopNonInteractiveSingleAppHost ▶️ View Recording
StopWithNoRunningAppHostExitsSuccessfully ▶️ View Recording
TypeScriptAppHostWithProjectReferenceIntegration ▶️ View Recording

📹 Recordings uploaded automatically from CI run #23225102961

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was already normalized as AppHost throughout, this is changing it to all lowercase. Would we need to update docs them too, or is this just a CLI concern?

@davidfowl davidfowl force-pushed the davidfowl/review-commands branch from 641e8db to d5e738c Compare March 13, 2026 14:53
@github-actions
Copy link
Contributor

The transient CI rerun workflow requested reruns for the following jobs after analyzing the failed attempt.
GitHub's job rerun API also reruns dependent jobs, so the retry is being tracked in the rerun attempt.
The job links below point to the failed attempt that matched the retry-safe transient failure rules.

@davidfowl
Copy link
Contributor Author

It was already normalized as AppHost throughout, this is changing it to all lowercase. Would we need to update docs them too, or is this just a CLI concern?

WE can change these all to AppHost but there's mixed casing and AppHost feels very .NET esquee

- Use 'apphost' (lowercase) consistently instead of mixed 'AppHost'/'apphost'
- Fix 'aspire export' missing trailing period
- Update 'aspire agent' description to 'Manage AI agent environment configuration.'
- Updated resx, Designer.cs, and all xlf localization files

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@JamesNK JamesNK force-pushed the davidfowl/review-commands branch from 5f48289 to f102f67 Compare March 18, 2026 00:51
@JamesNK JamesNK enabled auto-merge (squash) March 18, 2026 00:54
@github-actions
Copy link
Contributor

The transient CI rerun workflow requested reruns for the following jobs after analyzing the failed attempt.
GitHub's job rerun API also reruns dependent jobs, so the retry is being tracked in the rerun attempt.
The job links below point to the failed attempt that matched the retry-safe transient failure rules.

@JamesNK JamesNK disabled auto-merge March 18, 2026 02:02
@JamesNK
Copy link
Member

JamesNK commented Mar 18, 2026

/deployment-test

@github-actions
Copy link
Contributor

🚀 Deployment tests starting on PR #15204...

This will deploy to real Azure infrastructure. Results will be posted here when complete.

View workflow run

@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot had a problem deploying to deployment-testing March 18, 2026 02:09 Failure
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot had a problem deploying to deployment-testing March 18, 2026 02:09 Failure
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@github-actions github-actions bot temporarily deployed to deployment-testing March 18, 2026 02:09 Inactive
@JamesNK JamesNK merged commit 9c0b2bc into release/13.2 Mar 18, 2026
534 of 539 checks passed
@JamesNK JamesNK deleted the davidfowl/review-commands branch March 18, 2026 02:40
@github-actions
Copy link
Contributor

Deployment E2E Tests failed — 25 passed, 2 failed, 0 cancelled

View test results and recordings

View workflow run

Test Result Recording
Deployment.EndToEnd-VnetSqlServerConnectivityDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AcaCompactNamingDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-PythonFastApiDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-VnetKeyVaultConnectivityDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureEventHubsDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureLogAnalyticsDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureKeyVaultDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureServiceBusDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-VnetStorageBlobConnectivityDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AksStarterWithRedisDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-VnetKeyVaultInfraDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AuthenticationTests ✅ Passed
Deployment.EndToEnd-AppServicePythonDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AppServiceReactDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AcaStarterDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-VnetSqlServerInfraDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AcaExistingRegistryDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureStorageDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AcrPurgeTaskDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-VnetStorageBlobInfraDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureAppConfigDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AksStarterDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AcaDeploymentErrorOutputTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AzureContainerRegistryDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-AcaCustomRegistryDeploymentTests ✅ Passed ▶️ View Recording
Deployment.EndToEnd-TypeScriptExpressDeploymentTests ❌ Failed ▶️ View Recording
Deployment.EndToEnd-AcaCompactNamingUpgradeDeploymentTests ❌ Failed ▶️ View Recording

@dotnet-policy-service dotnet-policy-service bot added this to the 13.2 milestone Mar 18, 2026
Copilot AI pushed a commit that referenced this pull request Mar 18, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: James Newton-King <james@newtonking.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants