aspire docs api command

Questi contenuti non sono ancora disponibili nella tua lingua.

Name

aspire docs api - Browse, search, and retrieve Aspire API reference documentation from aspire.dev.

Synopsis

aspire docs api [command] [options]

Description

The aspire docs api command group provides access to the Aspire API reference documentation published on aspire.dev. Unlike the aspire docs commands that work with prose documentation pages, the aspire docs api commands are backed by the API reference index built from aspire.dev’s sitemap.

You can browse the API catalog by scope, search for specific types or members by keyword, or retrieve the full reference content for a specific API entry. Both C# and TypeScript API hierarchies are supported.

Options

The following options are available:

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

Commands

The following commands are available:

Command	Status	Function
`aspire docs api list <scope>`	Stable	Browse API reference entries under a given scope.
`aspire docs api search <query>`	Stable	Search Aspire API reference by keyword.
`aspire docs api get <id>`	Stable	Get the full content of an API reference entry by identifier.