-
Notifications
You must be signed in to change notification settings - Fork 57
Add aspire describe CLI command documentation
#502
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: release/13.2
Are you sure you want to change the base?
Changes from all commits
3734d98
923472e
981284f
3531b21
8f50ee5
7e8b181
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| --- | ||
| title: aspire describe command | ||
| description: Learn about the aspire describe command which displays resource details for a running Aspire AppHost, with optional continuous streaming. | ||
| --- | ||
|
|
||
| import Include from '@components/Include.astro'; | ||
| import { Aside, Steps } from '@astrojs/starlight/components'; | ||
|
|
||
| ## Name | ||
|
|
||
| `aspire describe` - Describe resources in a running AppHost. | ||
|
|
||
| ## Synopsis | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe [<resource>] [options] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| The `aspire describe` command displays resource details for a running Aspire AppHost. By default, it shows a snapshot table of all resources with their name, type, state, health status, and endpoints. 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: | ||
|
|
||
| <Steps> | ||
|
|
||
| 1. Scans for all running AppHost processes. | ||
| 2. If multiple AppHosts are running within the current directory scope, prompts you to select which one to target. | ||
| 3. If only one AppHost is running in scope, connects to it directly. | ||
| 4. If no in-scope AppHosts are found but out-of-scope AppHosts exist, displays all running AppHosts for selection. | ||
|
Comment on lines
+29
to
+32
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add an import to Steps and wrap this in that component.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in 3531b21 — added |
||
|
|
||
| </Steps> | ||
|
|
||
| <Aside type="tip"> | ||
| The `aspire resources` command is a backward-compatible alias for `aspire describe`. Both names invoke the same command. | ||
| </Aside> | ||
|
|
||
| ## 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. 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)](https://github.com/ndjson/ndjson-spec) 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>`** | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hey @copilot, please add a note about the format arg being case-insensitive.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added in 8f50ee5 — follows the same pattern as |
||
|
|
||
| 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)](https://github.com/ndjson/ndjson-spec) for streaming, emitting one JSON object per line. | ||
|
|
||
| - <Include relativePath="reference/cli/includes/option-help.md" /> | ||
|
|
||
| - <Include relativePath="reference/cli/includes/option-debug.md" /> | ||
|
|
||
| ## Examples | ||
|
|
||
| - Show all resources in a running AppHost: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe | ||
| ``` | ||
|
|
||
| Example output: | ||
|
|
||
| ```text title="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: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe webfrontend | ||
| ``` | ||
|
|
||
| - Continuously stream resource state changes: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe --follow | ||
| ``` | ||
|
|
||
| - Stream state changes for a specific resource: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe webfrontend --follow | ||
| ``` | ||
|
|
||
| - Output resource details as JSON: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe --format Json | ||
| ``` | ||
|
|
||
| - Stream resource changes as Newline Delimited JSON (NDJSON) for scripting: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe --follow --format Json | ||
| ``` | ||
|
|
||
| - Target a specific AppHost project: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire describe --apphost './src/MyApp.AppHost/MyApp.AppHost.csproj' | ||
| ``` | ||
|
|
||
| ## See also | ||
|
|
||
| - [aspire run](/reference/cli/commands/aspire-run/) | ||
| - [aspire ps](/reference/cli/commands/aspire-ps/) | ||
| - [aspire wait](/reference/cli/commands/aspire-wait/) | ||
| - [aspire stop](/reference/cli/commands/aspire-stop/) | ||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @copilot, we should update what's new in 13.2 with a link to this command.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a "Resource monitoring with
aspire describe" section under the CLI enhancements in the what's new 13.2 page in 3531b21. It covers the rename fromaspire resources, the--watch→--follow/-fchange, and includes a LearnMore link to the command reference.