Skip to content

Update --search option description with aka.ms link and field filter details - #17544

Merged
James Newton-King (JamesNK) merged 2 commits into
mainfrom
cli-search-option-docs
May 28, 2026
Merged

Update --search option description with aka.ms link and field filter details#17544
James Newton-King (JamesNK) merged 2 commits into
mainfrom
cli-search-option-docs

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Description

Updates the --search option description in the CLI to clarify that it supports full-text search and field filters, and adds a link to https://aka.ms/aspire/cli-search for more details.

The aka.ms link will be created separately to point to the relevant documentation.

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

@github-actions

github-actions Bot commented May 27, 2026

Copy link
Copy Markdown
Contributor

🚀 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/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17544

Or

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 updates the Aspire CLI --search option description text to mention full-text search, field filters, and an aka.ms link for more details, and propagates those string updates into localization XLF files.

Changes:

  • Updated telemetry --search help text to mention full-text + field-filter support and added https://aka.ms/aspire/cli-search.
  • Updated logs --search help text to add the aka.ms link.
  • Updated corresponding entries in multiple *.xlf localization files.

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 14 comments.

Show a summary per file
File Description
src/Aspire.Cli/Resources/TelemetryCommandStrings.resx Updates telemetry --search option description text and adds aka.ms link.
src/Aspire.Cli/Resources/LogsCommandStrings.resx Updates logs --search option description text to include aka.ms link.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.zh-Hant.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.zh-Hans.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.tr.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.ru.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.pt-BR.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.pl.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.ko.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.ja.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.it.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.fr.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.es.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.de.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/TelemetryCommandStrings.cs.xlf Updates localized XLF source/target for telemetry SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.zh-Hant.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.zh-Hans.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.tr.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.ru.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.pt-BR.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.pl.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.ko.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.ja.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.it.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.fr.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.es.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.de.xlf Updates localized XLF source/target for logs SearchOptionDescription.
src/Aspire.Cli/Resources/xlf/LogsCommandStrings.cs.xlf Updates localized XLF source/target for logs SearchOptionDescription.

Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
Comment on lines 50 to 53
<trans-unit id="SearchOptionDescription">
<source>Full-text search to filter log content</source>
<target state="new">Full-text search to filter log content</target>
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
<note />
Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
<trans-unit id="SearchOptionDescription">
<source>Full-text search to filter log content</source>
<target state="new">Full-text search to filter log content</target>
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
Comment on lines +51 to +52
<source>Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</source>
<target state="new">Search and filter log content fields such as messages, categories, and attribute values. Supports full-text search and field filters. See https://aka.ms/aspire/cli-search for more details</target>
</data>
<data name="SearchOptionDescription" xml:space="preserve">
<value>Full-text search to filter log content</value>
<value>Full-text search to filter log content. See https://aka.ms/aspire/cli-search for more details</value>
@github-actions

Copy link
Copy Markdown
Contributor

Re-running the failed jobs in the CI workflow for this pull request because 1 job was identified as retry-safe transient failures in the CI run attempt.
GitHub was asked to rerun all failed jobs for that attempt, and the rerun is being tracked in the rerun attempt.
The job links below point to the failed attempt jobs that matched the retry-safe transient failure rules.

@github-actions

Copy link
Copy Markdown
Contributor

CLI E2E Tests failed — 106 passed, 1 failed, 2 unknown (commit 0a3594c)

Failed Tests

View all recordings
Status Test Recording
AddPackageInteractiveWhileAppHostRunningDetached ▶️ View recording
AddPackageWhileAppHostRunningDetached ▶️ View recording
AgentCommands_AllHelpOutputs_AreCorrect ▶️ View recording
AgentInitCommand_DefaultSelection_InstallsDefaultSkills ▶️ View recording
AgentInitCommand_MigratesDeprecatedConfig ▶️ View recording
AgentMcpListStructuredLogsReturnsLogsFromStarterApp ▶️ View recording
AgentMcpListStructuredLogsReturnsLogsFromStarterApp_DevLocalhost ▶️ View recording
AgentMcpListStructuredLogsReturnsLogsFromStarterApp_Isolated ▶️ View recording
AllPublishMethodsBuildDockerImages ▶️ View recording
AspireAddAndStartWorkAgainstLegacyAppHostTs ▶️ View recording
AspireAddPackageVersionToDirectoryPackagesProps ▶️ View recording
AspireInitSingleFileAppHostRunsViaDotnetRunAppHost ▶️ View recording
AspireInitWithExistingAppHostDirRecreatesMissingNuGetConfigAndPreservesFiles ▶️ View recording
AspireInitWithSolutionFileGeneratesAppHostThatBuildsAgainstChannelHive ▶️ View recording
AspireStartUpdatesStaleTypeScriptAppHostPath ▶️ View recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps ▶️ View recording
AspireUpdateRemovesOrphanAppHostPackageVersionWhenSdkAlreadyCurrent ▶️ View recording
Banner_DisplayedOnFirstRun ▶️ View recording
Banner_DisplayedWithExplicitFlag ▶️ View recording
Banner_NotDisplayedWithNoLogoFlag ▶️ View recording
CertificatesClean_RemovesCertificates ▶️ View recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate ▶️ View recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate ▶️ View recording
ConfigSetGet_CreatesNestedJsonFormat ▶️ View recording
CreateAndRunAspireStarterProject ▶️ View recording
CreateAndRunAspireStarterProjectWithBundle ▶️ View recording
CreateAndRunEmptyAppHostProject ▶️ View failure recording
CreateAndRunJavaEmptyAppHostProject ▶️ View recording
CreateAndRunJsReactProject ▶️ View recording
CreateAndRunPythonReactProject ▶️ View recording
CreateAndRunTypeScriptEmptyAppHostProject ▶️ View recording
CreateAndRunTypeScriptStarterProject ▶️ View recording
CreateJavaAppHostWithViteApp ▶️ View recording
CreateTypeScriptAppHostWithViteApp_AllowsGuestAppPackageManagerToDiffer ▶️ View recording
CreateTypeScriptAppHostWithViteApp_UsesConfiguredToolchain ▶️ View recording
DashboardRunWithAgentMcpListTracesReturnsNoTraces ▶️ View recording
DashboardRunWithAgentMcpListTracesReturnsNoTraces_DevLocalhost ▶️ View recording
DashboardRunWithOtelTracesReturnsNoTraces ▶️ View recording
DashboardRunWithOtelTracesReturnsNoTraces_DevLocalhost ▶️ View recording
DeployK8sBasicApiService ▶️ View recording
DeployK8sWithExternalHelmChart ▶️ View recording
DeployK8sWithGarnet ▶️ View recording
DeployK8sWithMongoDB ▶️ View recording
DeployK8sWithMySql ▶️ View recording
DeployK8sWithPostgres ▶️ View recording
DeployK8sWithRabbitMQ ▶️ View recording
DeployK8sWithRedis ▶️ View recording
DeployK8sWithSqlServer ▶️ View recording
DeployK8sWithValkey ▶️ View recording
DeployTypeScriptAppToKubernetes ▶️ View recording
DescribeCommandResolvesReplicaNames ▶️ View recording
DescribeCommandShowsRunningResources ▶️ View recording
DetachFormatJsonProducesValidJson ▶️ View recording
DetachFormatJsonProducesValidJsonWhenRestartingExistingInstance ▶️ View recording
DoPublishAndDeployListStepsWork ▶️ View recording
DocsCommand_RendersInteractiveMarkdownFromLocalSource ▶️ View recording
DoctorCommand_DetectsDeprecatedAgentConfig ▶️ View recording
DoctorCommand_TypeScriptAppHostReportsMissingConfiguredToolchain ▶️ View recording
DoctorCommand_WithSslCertDir_ShowsTrusted ▶️ View recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted ▶️ View recording
GatewayWithoutExternalEndpoint_FailsPublishWithGuidance ▶️ View recording
GeneratedAspireDevScript_StartsWatchMode_WithConfiguredToolchain ▶️ View recording
GlobalMigration_HandlesCommentsAndTrailingCommas ▶️ View recording
GlobalMigration_HandlesMalformedLegacyJson ▶️ View recording
GlobalMigration_PreservesAllValueTypes ▶️ View recording
GlobalMigration_SkipsWhenNewConfigExists ▶️ View recording
GlobalSettings_MigratedFromLegacyFormat ▶️ View recording
IngressWithoutExternalEndpoint_FailsPublishWithGuidance ▶️ View recording
InitTypeScriptAppHost_AugmentsExistingViteRepoInWorkspaceSubdirectory ▶️ View recording
InteractiveCSharpInitCreatesExpectedFiles ▶️ View recording
InvalidAppHostPathWithComments_IsHealedOnRun ▶️ View recording
JavaScriptHostingApisRunFromTypeScriptAppHost ▶️ View recording
LatestCliCanStartStableChannelAppHost ▶️ View recording
LatestCliCanStartStableChannelTypeScriptAppHost ▶️ View recording
LegacySettingsMigration_AdjustsRelativeAppHostPath ▶️ View recording
LogsCommandShowsResourceLogs ▶️ View recording
OtelLogsReturnsStructuredLogsFromStarterApp ▶️ View recording
OtelLogsReturnsStructuredLogsFromStarterAppIsolated ▶️ View recording
PsCommandListsRunningAppHost ▶️ View recording
PsFormatJsonOutputsOnlyJsonToStdout ▶️ View recording
PublishJavaScriptPatternsGeneratesExpectedDockerComposeArtifacts ▶️ View recording
PublishWithConfigureEnvFileUpdatesEnvOutput ▶️ View recording
PublishWithDockerComposeServiceCallbackSucceeds ▶️ View recording
PublishWithoutOutputPathUsesAppHostDirectoryDefault ▶️ View recording
ResourceCommand_FailedExecution_DisplaysAppHostLogPathAndLogContainsEntries ▶️ View recording
ResourceCommand_SetAndDeleteParameterUpdatesDescribeOutput ▶️ View recording
RestoreGeneratesSdkFiles ▶️ View recording
RestoreGeneratesSdkFiles_WithConfiguredToolchain ▶️ View recording
RestoreRefreshesGeneratedSdkAfterAddingIntegration ▶️ View recording
RestoreSupportsConfigOnlyHelperPackageAndCrossPackageTypes ▶️ View recording
RunFromParentDirectory_UsesExistingConfigNearAppHost ▶️ View recording
RunReportsSyntaxErrorsForDotNetAppHost ▶️ View recording
RunReportsSyntaxErrorsForTypeScriptAppHost ▶️ View recording
SecretCrudOnDotNetAppHost ▶️ View recording
SecretCrudOnTypeScriptAppHost ▶️ View recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels ▶️ View recording
StartAndWaitForTypeScriptSqlServerAppHostWithNativeAssets ▶️ View recording
StartReportsSyntaxErrorsForDotNetAppHost ▶️ View recording
StartReportsSyntaxErrorsForTypeScriptAppHost ▶️ View recording
StopAllAppHostsFromAppHostDirectory ▶️ View recording
StopJavaPolyglotAppHostUsingApphostDirectory ▶️ View recording
StopNonInteractiveSingleAppHost ▶️ View recording
StopTypeScriptPolyglotAppHostUsingApphostDirectory ▶️ View recording
StopWithNoRunningAppHostExitsSuccessfully ▶️ View recording
UnAwaitedChainsCompileWithAutoResolvePromises ▶️ View recording
UpdateProjectChannelToStable_CSharpEmptyAppHost_PreservesAspireConfigChannel ▶️ View recording
UpdateProjectChannelToStable_CSharpSingleFileInit_PreservesAspireConfigChannel ▶️ View recording
UpdateProjectChannelToStable_TypeScriptSingleFileInit_PreservesAspireConfigChannel ▶️ View recording
UpdateProjectChannelToStable_TypeScript_PreviewsStablePackagesAndPreservesChannel ▶️ View recording

📹 Recordings uploaded automatically from CI run #26520377772

@JamesNK
James Newton-King (JamesNK) merged commit 7255938 into main May 28, 2026
614 of 619 checks passed
@JamesNK
James Newton-King (JamesNK) deleted the cli-search-option-docs branch May 28, 2026 00:22
@github-actions github-actions Bot added this to the 13.5 milestone May 28, 2026
@JamesNK

Copy link
Copy Markdown
Member Author

/backport to release/13.4

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/13.4 (link to workflow run)

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Pull request created: #1107

Generated by PR Documentation Check

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

📝 Documentation has been drafted in microsoft/aspire.dev#1107 targeting release/13.4.

Added the --search option to four CLI command reference pages that previously did not document this option at all. The updated descriptions reflect the changes from the source PR (LogsCommandStrings.resx and TelemetryCommandStrings.resx), including the mention of field filter support and the `(aka.ms/redacted) reference link.

Files modified:

  • src/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdx
  • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx
  • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx
  • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx

Note

This draft PR needs human review before merging.

@github-actions github-actions Bot locked and limited conversation to collaborators Jun 27, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants