Add WithTerminal docs and aspire terminal CLI reference#1329
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds new documentation pages for the experimental WithTerminal() feature and the aspire terminal CLI command group, and wires them into the docs navigation and Aspire 13.5 release notes.
Changes:
- Adds a new AppHost guide page for
WithTerminal()and new CLI reference pages foraspire terminal,aspire terminal attach, andaspire terminal ps. - Updates sidebar topic configuration to point “Interactive terminals” at the new slug and adds an
aspire terminalcommand group under CLI reference. - Fixes the Aspire 13.5 “Learn more” link to the correct
with-terminalslug.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/whats-new/aspire-13-5.mdx | Updates the 13.5 “Learn more” link to the new WithTerminal page slug. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-terminal.mdx | Adds CLI reference landing page for the aspire terminal command group and feature-flag guidance. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-terminal-attach.mdx | Adds CLI reference for attaching to a terminal session, including roles and hotkeys. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-terminal-ps.mdx | Adds CLI reference for listing terminal sessions, including --format and --verbose details. |
| src/frontend/src/content/docs/app-host/with-terminal.mdx | Adds the primary WithTerminal feature guide with examples and operational notes. |
| src/frontend/config/sidebar/reference.topics.ts | Adds aspire terminal group to the CLI reference sidebar. |
| src/frontend/config/sidebar/docs.topics.ts | Repoints “Interactive terminals” to app-host/with-terminal. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 7/7 changed files
- Comments generated: 5
- Review effort level: Low
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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>
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
…ance 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>
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.
Summary
Adds documentation for the experimental
WithTerminal()feature (shipping in Aspire 13.5) and theaspire terminalCLI commands.This fills the dangling "Interactive terminals" sidebar entry and the 13.5 what's-new
LearnMorelink, both of which previously pointed at a non-existentapp-host/withterminalslug.New pages
app-host/with-terminal.mdx— feature guide. Opens with the fluentWithTerminal(...)API and a minimal example, then covers:TerminalOptions(Columns/Rows/Shell/ShowTerminalHost), replica behavior, thewithTerminal()TypeScript export, and the CLI feature flagreference/cli/commands/aspire-terminal.mdx— parent commandreference/cli/commands/aspire-terminal-attach.mdx—attach <resource>with--replica,--viewer, and theCtrl+B D/Ctrl+B Thotkeysreference/cli/commands/aspire-terminal-ps.mdx—pswith--format,--verbose, table columns, and JSON schemaOther changes
docs.topics.ts(repointed the existing Interactive terminals entry toapp-host/with-terminal) andreference.topics.ts(newaspire terminalgroup).All pages are marked experimental/Preview and note that the
aspire terminalcommands are gated behindaspire config set features.terminalCommandsEnabled trueand require Aspire.Hosting 13.4+ (terminals.v1).Validation
pnpm --dir ./src/frontend run lint✅ (includesastro sync)pnpm --dir ./src/frontend test:unit✅ (249 tests)Note
Targets
release/13.5since the feature ships in Aspire 13.5.