aspire docs search command

Name

aspire docs search - Search Aspire documentation by keywords.

Synopsis

Aspire CLI

aspire docs search <query> [options]

Description

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

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

Arguments

• <query>

  The search query. Use keywords to describe what you’re looking for. For best results, include relevant terms such as API names, configuration keys, or feature names.

Options

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.

• -d, --debug

  Enable debug logging to the console, which prints detailed information about what Aspire CLI is doing when a command is run.

• --non-interactive

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

• --wait-for-debugger

  Wait for a debugger to attach before running a command.

Examples

• Search for documentation about Redis:

  Aspire CLI

  aspire docs search "redis"

• Search with a custom result limit:

  Aspire CLI

  aspire docs search "service defaults" --limit 3

• Search and output results in JSON format:

  Aspire CLI

  aspire docs search "deployment" --format Json

See also

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