Skip to content

[docs] Add WithTerminal() interactive terminal sessions page#1244

Draft
mitchdenny wants to merge 1 commit into
release/13.5from
mitchdenny/docs-withterminal-13-5
Draft

[docs] Add WithTerminal() interactive terminal sessions page#1244
mitchdenny wants to merge 1 commit into
release/13.5from
mitchdenny/docs-withterminal-13-5

Conversation

@mitchdenny

Copy link
Copy Markdown
Member

Adds documentation for the WithTerminal() experimental API introduced in Aspire 13.5 (microsoft/aspire#17866).

Changes

  • New page: app-host/withterminal.mdx — covers basic usage, custom dimensions, multi-replica support, dashboard terminal view, and the aspire terminal attach / aspire terminal ps CLI commands
  • Sidebar entry added to Resource types section after "Executable resources"

Source PR

microsoft/aspire#17866 — "WithTerminal(): per-replica interactive terminal sessions (Aspire side)"

Notes

  • The feature is marked experimental (ASPIRETERMINAL001); the page includes the required #pragma warning disable patterns
  • TypeScript options overload (dimensions) is not yet supported — noted inline
  • Windows executables only for 13.5; Linux/macOS/containers are noted as follow-ups

/cc @adamint (SME from source PR reviews)

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>
@mitchdenny mitchdenny changed the base branch from main to release/13.5 June 10, 2026 14:11
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

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

VS Code: Open PR #1244 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

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.

1 participant