[docs] Add WithTerminal() interactive terminal sessions page#1244
Merged
Conversation
Documents the WithTerminal() experimental API introduced in Aspire 13.5: - Basic usage (C# and TypeScript) - Custom terminal dimensions - Multi-replica support - Dashboard terminal view - aspire terminal attach / aspire terminal ps CLI commands Closes microsoft/aspire#17866 (docs obligation) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
This was referenced Jun 11, 2026
mitchdenny
marked this pull request as ready for review
June 11, 2026 04:18
Contributor
There was a problem hiding this comment.
Pull request overview
Adds new Aspire AppHost documentation for the experimental WithTerminal() API (interactive PTY sessions), and links it into the AppHost “Resource types” navigation.
Changes:
- Added a new
app-host/withterminal.mdxpage covering basic usage, sizing, replica behavior, dashboard access, and related CLI commands. - Added a new sidebar item under Resource types pointing to the new page.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/app-host/withterminal.mdx | New docs page describing interactive terminal sessions via WithTerminal() (C# + TypeScript examples). |
| src/frontend/config/sidebar/docs.topics.ts | Adds the new “Interactive terminals” entry to the AppHost Resource types sidebar section. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 4
- remove redundant sidebar translations block - clean up unused import and wording updates - fix CLI reference link target - remove duplicate build/run call in dimensions sample Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
davidfowl
approved these changes
Jun 11, 2026
mitchdenny
enabled auto-merge (squash)
June 11, 2026 04:44
mitchdenny
pushed a commit
that referenced
this pull request
Jul 6, 2026
Remove the duplicate withterminal.mdx (from #1244) in favor of the kebab-case with-terminal.mdx, matching the app-host directory naming convention. Fold in the dashboard section and the TypeScript config tracking issue reference. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
mitchdenny
added a commit
that referenced
this pull request
Jul 6, 2026
* Add WithTerminal docs and aspire terminal CLI reference Document the experimental WithTerminal() AppHost API for exposing interactive terminal sessions on resources, plus the aspire terminal, aspire terminal attach, and aspire terminal ps CLI commands. Wires the new pages into the docs and reference sidebars and repoints the 13.5 what's-new link to the new slug. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Frame no-auto-debugger as a temporary NOTE callout Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Give C# and TypeScript equal billing in with-terminal docs Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Consolidate WithTerminal docs onto with-terminal.mdx Remove the duplicate withterminal.mdx (from #1244) in favor of the kebab-case with-terminal.mdx, matching the app-host directory naming convention. Fold in the dashboard section and the TypeScript config tracking issue reference. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Address PR review: self-contained snippets and ASPIRETERMINAL001 guidance Add the #pragma warning disable ASPIRETERMINAL001 suppression to the C# examples, make the Experimental aside actionable, and make the configure and replicas snippets self-contained (full builder bootstrap + run) for both C# and TypeScript. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Mitch Denny <midenn@Mac.localdomain> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.
Adds documentation for the
WithTerminal()experimental API introduced in Aspire 13.5 (microsoft/aspire#17866).Changes
app-host/withterminal.mdx— covers basic usage, custom dimensions, multi-replica support, dashboard terminal view, and theaspire terminal attach/aspire terminal psCLI commandsSource PR
microsoft/aspire#17866 — "WithTerminal(): per-replica interactive terminal sessions (Aspire side)"
Notes
ASPIRETERMINAL001); the page includes the required#pragma warning disablepatterns/cc @adamint (SME from source PR reviews)