# aspire docs list command

## Name

`aspire docs list` - List all available Aspire documentation pages.

## Synopsis

```bash title="Aspire CLI"
aspire docs list [options]
```

<AsciinemaPlayer
  src="/casts/aspire-docs-list.cast"
  poster="npt:0:01"
  rows={20}
  loop={false}
  speed={.5}
/>

## Description

The `aspire docs list` command retrieves and displays all available documentation pages from [aspire.dev](https://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`](../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`.

- <Include relativePath="reference/cli/includes/option-help.md" />

- <Include relativePath="reference/cli/includes/option-log-level.md" />

- <Include relativePath="reference/cli/includes/option-non-interactive.md" />

- <Include relativePath="reference/cli/includes/option-nologo.md" />

- <Include relativePath="reference/cli/includes/option-banner.md" />

- <Include relativePath="reference/cli/includes/option-wait.md" />

## Examples

- List all available documentation pages:

  ```bash title="Aspire CLI"
  aspire docs list
  ```

- List all pages in JSON format:

  ```bash title="Aspire CLI"
  aspire docs list --format Json
  ```

## See also

- [aspire docs command](../aspire-docs/)
- [aspire docs search command](../aspire-docs-search/)
- [aspire docs get command](../aspire-docs-get/)