aspire docs list command

Name

aspire docs list - List all available Aspire documentation pages.

Synopsis

Aspire CLI

aspire docs list [options]

Description

The aspire docs list command retrieves and displays all available documentation pages from aspire.dev. The output includes page titles, URL slugs, and brief summaries for each page.

Use this command to browse the documentation catalog and discover available topics. The slugs returned can be passed to the aspire docs get command to retrieve the full content of a specific page.

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.

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

• List all available documentation pages:

  Aspire CLI

  aspire docs list

• List all pages in JSON format:

  Aspire CLI

  aspire docs list --format Json

See also

• aspire docs command
• aspire docs search command
• aspire docs get command