Add `aspire describe` CLI command documentation by Copilot · Pull Request #502 · microsoft/aspire.dev

Copilot · 2026-03-04T02:05:17Z

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

…ces) Addresses #461: CLI aspire resources renamed to aspire describe with --watch renamed to --follow/-f. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

IEvangelist

This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback/suggestions. @copilot

IEvangelist · 2026-03-04T02:58:23Z

src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx

+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.


Add an import to Steps and wrap this in that component.

Done in 3531b21 — added Steps import and wrapped the numbered list in the <Steps> component.

IEvangelist · 2026-03-04T02:59:13Z

src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx

+  aspire describe --format Json
+  ```
+
+- Stream resource changes as NDJSON for scripting:


Hey @copilot what is NDJSON BTW?

NDJSON stands for Newline Delimited JSON — a streaming-friendly format where each line is a standalone JSON object. Updated in 3531b21 to expand the acronym everywhere it appears and added links to ndjson.org.

IEvangelist · 2026-03-04T03:00:06Z

src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx

Hey @copilot, we should update what's new in 13.2 with a link to this command.

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 from aspire resources, the --watch → --follow/-f change, and includes a LearnMore link to the command reference.

- Wrap numbered list in Steps component per review feedback - Expand NDJSON acronym to Newline Delimited JSON with links - Add 'Resource monitoring with aspire describe' section to what's new 13.2 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Copilot · 2026-03-04T03:07:01Z

This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback/suggestions. @copilot

All three review items addressed in 3531b21. I also ran doc-tester validation using Playwright against the dev server:

✅ aspire-describe page renders correctly with Steps component and NDJSON links
✅ All 4 internal See Also links return HTTP 200
✅ What's new 13.2 page renders the new "Resource monitoring with aspire describe" section with working link back to the command reference
✅ Sidebar shows aspire describe in correct alphabetical position

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

ndjson.org
- Triggering command: /usr/bin/curl curl -s -o /dev/null -w %{http_code} REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

IEvangelist · 2026-03-04T13:18:54Z

src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx

+
+  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>`**


Hey @copilot, please add a note about the format arg being case-insensitive.

Added in 8f50ee5 — follows the same pattern as aspire wait (Values are case-insensitive.).

IEvangelist · 2026-03-04T13:20:12Z

src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx

+
+- **`-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)](http://ndjson.org/) format).


Sorry but that link is sus! @copilot - we need to triple check this. Are you sure? Seems fake or phishy.

Good catch — ndjson.org appears to be dead/parked. Replaced both occurrences with the canonical GitHub spec repo at https://github.com/ndjson/ndjson-spec in 7e8b181.

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Copilot · 2026-03-04T13:26:54Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

ndjson.org
- Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Initial plan

3734d98

Copilot AI assigned Copilot and IEvangelist Mar 4, 2026

Copilot started work on behalf of IEvangelist March 4, 2026 02:05 View session

Copilot AI and others added 2 commits March 4, 2026 02:13

Add aspire describe command documentation (renamed from aspire resour…

923472e

…ces) Addresses #461: CLI aspire resources renamed to aspire describe with --watch renamed to --follow/-f. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Fix alphabetical ordering of aspire describe in sidebar

981284f

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Use doc writer skill to address issue #461~~ Add aspire describe CLI command documentation Mar 4, 2026

Copilot finished work on behalf of IEvangelist March 4, 2026 02:15

IEvangelist approved these changes Mar 4, 2026

View reviewed changes

Copilot started work on behalf of IEvangelist March 4, 2026 03:00 View session

IEvangelist marked this pull request as ready for review March 4, 2026 03:00

IEvangelist requested a review from mitchdenny as a code owner March 4, 2026 03:00

IEvangelist approved these changes Mar 4, 2026

View reviewed changes

Copilot finished work on behalf of IEvangelist March 4, 2026 03:07

IEvangelist reviewed Mar 4, 2026

View reviewed changes

Copilot started work on behalf of IEvangelist March 4, 2026 13:19 View session

IEvangelist requested changes Mar 4, 2026

View reviewed changes

Add case-insensitive note to --format option

8f50ee5

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Copilot finished work on behalf of IEvangelist March 4, 2026 13:24

Copilot started work on behalf of IEvangelist March 4, 2026 13:24 View session

Replace ndjson.org links with GitHub spec repo

7e8b181

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

Copilot finished work on behalf of IEvangelist March 4, 2026 13:27


		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>`


		- `-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)](http://ndjson.org/) format).

Conversation

Copilot AI commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IEvangelist left a comment

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

IEvangelist Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Mar 4, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Mar 4, 2026 •

edited

Loading

Copilot AI commented Mar 4, 2026 •

edited

Loading