# aspire docs api list command

## Name

`aspire docs api list` - Browse API reference entries under a given scope.

## Synopsis

```bash title="Aspire CLI"
aspire docs api list <scope> [options]
```

## Description

The `aspire docs api list` command lets you navigate the Aspire API reference catalog from [aspire.dev](https://aspire.dev) in a scoped, hierarchical way. Rather than returning the entire catalog at once, `list` returns only the direct children of the provided scope.

Start with a language root (`csharp` or `typescript`) to see the top-level packages or modules, then progressively narrow the scope to explore types, member groups, and individual members.

## Arguments

- **`<scope>`**

  The scope to browse. Use a language root or a path-based identifier to navigate the API hierarchy.

  **C# scopes:**

  | Scope | Returns |
  | --- | --- |
  | `csharp` | Top-level C# packages |
  | `csharp/<package>` | Types in the package |
  | `csharp/<package>/<type>` | Member-group pages (for example, `methods`, `properties`, `constructors`) |

  **TypeScript scopes:**

  | Scope | Returns |
  | --- | --- |
  | `typescript` | Top-level TypeScript modules |
  | `typescript/<module>` | Direct symbols in the module |
  | `typescript/<module>/<symbol>` | Members under the symbol |

  If a scope has no children, `list` returns no results.

## 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 top-level C# packages:

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

- List all types in a specific C# package:

  ```bash title="Aspire CLI"
  aspire docs api list csharp/aspire.hosting
  ```

- List member groups for a specific C# type:

  ```bash title="Aspire CLI"
  aspire docs api list csharp/aspire.hosting/idistributedapplicationbuilder
  ```

- List all top-level TypeScript modules:

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

- List symbols in a specific TypeScript module:

  ```bash title="Aspire CLI"
  aspire docs api list typescript/aspire.hosting
  ```

- List results in JSON format:

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

## See also

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