aspire docs get command

Name

aspire docs get - Get the full content of a documentation page by its slug.

Synopsis

Aspire CLI

aspire docs get <slug> [options]

Description

The aspire docs get command retrieves and displays the full content of a specific documentation page from aspire.dev. Use the aspire docs list command to browse available pages, or the aspire docs search command to find relevant content by keyword.

You can optionally filter the output to a specific section of the page by providing a section heading with the --section option.

Arguments

• <slug>

  The slug of the documentation page to retrieve. For example, redis-integration or getting-started. Use the aspire docs list or aspire docs search commands to discover available slugs.

Options

The following options are available:

• --section <section>

  Return only the specified section of the page. Provide the section heading to filter the output to that section and its content.

• --format <Table|Json>

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

• -?, -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

• Get the full content of the Redis integration page:

  Aspire CLI

  aspire docs get redis-integration

• Get only a specific section from a documentation page:

  Aspire CLI

  aspire docs get redis-integration --section "Add Redis resource"

• Get page content in JSON format:

  Aspire CLI

  aspire docs get getting-started --format Json

See also

• aspire docs command
• aspire docs list command
• aspire docs search command