aspire docs search command

aspire docs search - Search Aspire documentation by keywords.

aspire docs search <query> [options]

The aspire docs search command performs a relevance-ranked search across the Aspire documentation on aspire.dev. Results include the page title, slug, matching section, and a relevance score.

The ranker rewards exact title, slug, and heading matches and uses inverse document frequency (IDF) weighting so common terms such as new or azure count less than specific terms. Version separators are normalized so queries like whats new 13.5, what's new 13-5, and whats new 135 all match the same pages. Explicit release-note queries (for example, whats new 13.5 or changelog) surface What’s New pages at the top, while incidental mentions in feature docs do not outrank the dedicated pages.

The slugs returned in search results can be passed to the aspire docs get command to retrieve the full content of a matching page.

• <query>

  The search query. For best results, use multi-word phrases that match the title or heading you are looking for (for example, "service discovery" or "azure container apps environment"). Specific API names, configuration keys, and feature names work well. Version numbers in the form 13.5, 13-5, or 135 are all equivalent and match What’s New pages for that release.

The following options are available:

• --format <Table|Json>

  Output format. Choose Table for a human-readable table or Json for machine-readable JSON output. Defaults to Table.

• -n, --limit <limit>

  Maximum number of search results to return. Defaults to 5, with a maximum of 10.

• -?, -h, --help

  Prints help and usage documentation for the available commands and options.

• -l, --log-level <Critical|Debug|Error|Information|None|Trace|Warning>

  Set the minimum log level for console output. Use this option to increase diagnostics while troubleshooting or reduce output in scripted runs.

• --non-interactive

  Run the command in non-interactive mode, disabling all interactive prompts and spinners.

• --nologo

  Suppress the startup banner and telemetry notice.

• --banner

  Display the animated Aspire CLI welcome banner.

• --wait-for-debugger

  Wait for a debugger to attach before running a command.

• Search for documentation about Redis:

  aspire docs search "redis"

• Search for What’s New content for a specific release:

  aspire docs search "whats new 13.5"

• Find documentation for a multi-word feature by phrase:

  aspire docs search "service discovery"
  aspire docs search "azure container apps environment"

• Search with a custom result limit:

  aspire docs search "service defaults" --limit 3

• Search and output results in JSON format:

  aspire docs search "deployment" --format Json

• aspire docs command
• aspire docs list command
• aspire docs get command