aspire docs api list command

このコンテンツはまだ日本語訳がありません。

Name

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

Synopsis

aspire docs api list <scope> [options]

Description

The aspire docs api list command lets you navigate the Aspire API reference catalog from 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.

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

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

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.
-l, --log-level <Critical|Debug|Error|Information|None|Trace|Warning>

Set the minimum log level for console output. Use this option to increase diagnostics while troubleshooting or reduce output in scripted runs.
--non-interactive

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

Suppress the startup banner and telemetry notice.
--banner

Display the animated Aspire CLI welcome banner.
--wait-for-debugger

Wait for a debugger to attach before running a command.

Examples

List all top-level C# packages:
Aspire CLI
```
aspire docs api list csharp
```
List all types in a specific C# package:
Aspire CLI
```
aspire docs api list csharp/aspire.hosting
```

List member groups for a specific C# type:

aspire docs api list csharp/aspire.hosting/idistributedapplicationbuilder

List all top-level TypeScript modules:
Aspire CLI
```
aspire docs api list typescript
```
List symbols in a specific TypeScript module:
Aspire CLI
```
aspire docs api list typescript/aspire.hosting
```

List results in JSON format:

aspire docs api list csharp --format Json