Skip to content

Add WithTerminal docs and aspire terminal CLI reference#1329

Merged
mitchdenny merged 5 commits into
release/13.5from
mitchdenny-curly-dollop
Jul 6, 2026
Merged

Add WithTerminal docs and aspire terminal CLI reference#1329
mitchdenny merged 5 commits into
release/13.5from
mitchdenny-curly-dollop

Conversation

@mitchdenny

Copy link
Copy Markdown
Member

Summary

Adds documentation for the experimental WithTerminal() feature (shipping in Aspire 13.5) and the aspire terminal CLI commands.

This fills the dangling "Interactive terminals" sidebar entry and the 13.5 what's-new LearnMore link, both of which previously pointed at a non-existent app-host/withterminal slug.

New pages

  • app-host/with-terminal.mdx — feature guide. Opens with the fluent WithTerminal(...) API and a minimal example, then covers:
    • When to use it (TUI apps, shell experiences)
    • The debugger is not attached automatically (DCP can't run a process under the debugger and a PTY simultaneously; attach manually)
    • Multiple peers can attach at once — two browser tabs (or a tab + the CLI) on the same terminal stay responsive, with primary/viewer roles
    • TerminalOptions (Columns/Rows/Shell/ShowTerminalHost), replica behavior, the withTerminal() TypeScript export, and the CLI feature flag
  • reference/cli/commands/aspire-terminal.mdx — parent command
  • reference/cli/commands/aspire-terminal-attach.mdxattach <resource> with --replica, --viewer, and the Ctrl+B D / Ctrl+B T hotkeys
  • reference/cli/commands/aspire-terminal-ps.mdxps with --format, --verbose, table columns, and JSON schema

Other changes

  • Wired the new pages into docs.topics.ts (repointed the existing Interactive terminals entry to app-host/with-terminal) and reference.topics.ts (new aspire terminal group).
  • Fixed the 13.5 what's-new link to the new slug.

All pages are marked experimental/Preview and note that the aspire terminal commands are gated behind aspire config set features.terminalCommandsEnabled true and require Aspire.Hosting 13.4+ (terminals.v1).

Validation

  • pnpm --dir ./src/frontend run lint ✅ (includes astro sync)
  • pnpm --dir ./src/frontend test:unit ✅ (249 tests)

Note

Targets release/13.5 since the feature ships in Aspire 13.5.

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>
Copilot AI review requested due to automatic review settings July 6, 2026 03:51
@mitchdenny mitchdenny changed the base branch from main to release/13.5 July 6, 2026 03:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 for aspire terminal, aspire terminal attach, and aspire terminal ps.
  • Updates sidebar topic configuration to point “Interactive terminals” at the new slug and adds an aspire terminal command group under CLI reference.
  • Fixes the Aspire 13.5 “Learn more” link to the correct with-terminal slug.
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

Comment thread src/frontend/src/content/docs/app-host/with-terminal.mdx
Comment thread src/frontend/src/content/docs/app-host/with-terminal.mdx Outdated
Comment thread src/frontend/src/content/docs/app-host/with-terminal.mdx
Comment thread src/frontend/src/content/docs/app-host/with-terminal.mdx Outdated
Comment thread src/frontend/src/content/docs/app-host/with-terminal.mdx Outdated
Mitch Denny and others added 2 commits July 6, 2026 14:14
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
mitchdenny pushed a commit that referenced this pull request Jul 6, 2026
…l scenarios

The WithTerminal docs are added in PR #1329 (app-host/with-terminal). This
forward link will resolve once #1329 merges.

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>
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1329. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1329 artifacts

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>
@mitchdenny mitchdenny merged commit ec461ab into release/13.5 Jul 6, 2026
10 checks passed
@mitchdenny mitchdenny deleted the mitchdenny-curly-dollop branch July 6, 2026 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants