Repository navigation
[docs] Document aspire ps --output snapshot mode - #1910
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Alistair Matthews (alistairmatthews)
marked this pull request as ready for review
October 22, 2026 14:20
Alistair Matthews (alistairmatthews)
requested a review
from David Pine (IEvangelist)
as a code owner
October 22, 2026 14:20
Alistair Matthews (alistairmatthews)
approved these changes
Oct 22, 2026
Alistair Matthews (alistairmatthews)
left a comment
Alistair Matthews (alistairmatthews)
left a comment
Collaborator
There was a problem hiding this comment.
No changes required. Ready to go.
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented feature is absent from the matching source release branch, and the exit-code guidance omits protocol-limit failures.
2 open issues
What changed in this PR
This PR extends the existing aspire ps command reference with snapshot-stream guidance for monitoring tools and the native tray, following microsoft/aspire#21135.
Changes:
- Documents
--output <Default|Snapshot>, its default, and required flags. - Adds a snapshot-stream command example.
- Describes shutdown and exit-code behavior.
| File | Description |
|---|---|
src/frontend/src/content/docs/reference/cli/commands/aspire-ps.mdx |
Adds snapshot-mode options, usage, and exit-code guidance. |
Review effort: Balanced
Comment on lines
+57
to
+59
| - **`--output <Default|Snapshot>`** | ||
|
|
||
| Output mode for `--follow` streaming. `Default` emits one changed AppHost record per NDJSON line, as described for `--follow` above. `Snapshot` emits full AppHost snapshots that also include resource health and heartbeat updates, intended for monitoring tools and the native tray rather than interactive use. `Snapshot` requires both `--follow` and `--format Json`. Defaults to `Default`. |
| aspire ps --output Snapshot --follow --format Json --non-interactive --nologo | ||
| ``` | ||
|
|
||
| Normal shutdown of this stream (including the consumer disconnecting or the command being canceled) exits with code `0`. Only an actual AppHost discovery failure exits with a non-zero code. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#21135
@JamesNKTarget branch
Targeting
release/17.0based on the source PR milestone17.0(candidate_source: pr_milestone,target_resolution: exact_match).Why this is needed
microsoft/aspire#21135 fixes a cancellation race in the CLI's tray snapshot-watch stream (
TrayWatchStream.cs) and, in its "User-facing usage" section, shows the command that monitoring tools and the native tray use:The
aspire pscommand's--outputoption (Default/Snapshot) was not documented anywhere on aspire.dev —reference/cli/commands/aspire-ps.mdxonly covered--followand--format. This PR closes that gap and records the behavior change from #21135: normal stream shutdown (including cancellation) now exits with code0instead of intermittently reporting a discovery failure.Triggered signals:
pr_body_has_cli_flag_mention(the--output snapshotexample in the PR body),pr_body_has_user_facing_section(the "User-facing usage" heading).What changed
src/frontend/src/content/docs/reference/cli/commands/aspire-ps.mdx--output <Default|Snapshot>option.aspire ps --output Snapshot --follow --format Json --non-interactive --nologo.0, and only an actual discovery failure returns a non-zero exit code.No new pages were created; this is an update to an existing command reference page.