aspire describe command

Это содержимое пока не доступно на вашем языке.

Name

aspire describe - Describe resources in a running AppHost.

Synopsis

aspire describe [<resource>] [options]

Description

The aspire describe command displays resource details for a running Aspire AppHost. It shows a table of resources with their name, type, state, health status, and URLs. Hidden resources are excluded by default; use the --include-hidden option to show them. Use the --follow option to continuously stream resource state changes in real time.

When a specific resource name is provided, only matching resources are displayed. If no matching resource is found, the command returns an error.

When executed without the --apphost option, the command:

Scans for all running AppHost processes.
If multiple AppHosts are running within the current directory scope, prompts you to select which one to target.
If only one AppHost is running in scope, connects to it directly.
If no in-scope AppHosts are found but out-of-scope AppHosts exist, displays all running AppHosts for selection.

Arguments

<resource>

The name of the resource to display. If not specified, all resources are shown.

Options

The following options are available:

-f, --follow

Continuously stream resource state changes. The current state of every resource is emitted immediately when streaming starts, even if no further changes occur, and then each subsequent update is emitted as it happens. In table mode, each update prints a line showing the resource name, state, health, and endpoints. In JSON mode, each update emits a single JSON object per line (Newline Delimited JSON (NDJSON) format).
--apphost <path>

The path to the Aspire AppHost project file. When specified, the command connects to the AppHost running from that project file without prompting for selection.
--format <Json|Table>

Output format. Use Json for machine-readable output suitable for scripting and automation. Defaults to Table. Values are case-insensitive.

In snapshot mode (without --follow), JSON output wraps resources in a { "resources": [...] } object. In follow mode, JSON output uses Newline Delimited JSON (NDJSON) for streaming, emitting one JSON object per line.
--include-hidden

Includes resources that are marked as hidden. By default, hidden resources are not shown. When a specific resource name is provided, hidden resources are always included regardless of this option.
-?, -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

Show all resources in a running AppHost:

aspire describe

Example output:

Name            Type        State    Health    Endpoints
cache           container   Running  Healthy   tcp://localhost:63122
webfrontend     project     Running  Healthy   https://localhost:17015, http://localhost:15099
apiservice      project     Running  Healthy   https://localhost:17016, http://localhost:15100

Show details for a specific resource:
Aspire CLI
```
aspire describe webfrontend
```
Continuously stream resource state changes:
Aspire CLI
```
aspire describe --follow
```
Stream state changes for a specific resource:
Aspire CLI
```
aspire describe webfrontend --follow
```
Output resource details as JSON:
Aspire CLI
```
aspire describe --format Json
```
Stream resource changes as Newline Delimited JSON (NDJSON) for scripting:
Aspire CLI
```
aspire describe --follow --format Json
```

Target a specific AppHost project:

aspire describe --apphost './src/MyApp.AppHost/MyApp.AppHost.csproj'

Show all resources including hidden ones:
Aspire CLI
```
aspire describe --include-hidden
```