Repository navigation
Document dashboard and AppHost terminals for Aspire 13.6 - #1684
Merged
Mitch Denny (mitchdenny) merged 27 commits intoSep 29, 2026
Merged
Mitch Denny (mitchdenny) merged 27 commits into
Mitch Denny (mitchdenny) merged 27 commits into
Conversation
Related to #1663. Add terminal scenarios, tape automation, and CLI references. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Update namespace imports, tape producer waits, interaction context guidance, and source pins. Add focused screenshots and terminal navigation, and address reviewer cross-links. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> # Conflicts: # src/frontend/src/content/docs/app-host/with-terminal.mdx
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Preserve the detailed terminal interaction guide alongside the refreshed release screenshots. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace custom dock guidance with Redis REPL examples and a matching screenshot. Keep terminal interaction authoring in the deeper guides. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…examples Reference terminal samples at their intended main paths, focus the dock walkthrough on TerminalService, and replace the client catalog with concise C# and TypeScript examples in each integration guide. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Move automation helpers and sample guidance into an AppHost automation page, distinguish it from tape playback in navigation, and replace the launch-options table with a code listing. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Preserve existing main-era URLs and add redirects for relocated guides. Extract terminal interactions without changing the examples. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Move the Preview badge to the section, remove custom shell prompts and troubleshooting, and clarify Source and supported recording output. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Consolidate REPL guides while preserving anchors and integration-specific safety guidance. Resolve security documentation conflict, remove stale CLI flag steps, and reduce duplicated walkthroughs and unused assets. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Mitch Denny (mitchdenny)
marked this pull request as ready for review
September 29, 2026 04:59
Mitch Denny (mitchdenny)
requested review from
James Newton-King (JamesNK) and
Eric Erhardt (eerhardt)
as code owners
September 29, 2026 04:59
Mitch Denny (mitchdenny)
enabled auto-merge (squash)
September 29, 2026 04:59
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The dashboard guide references a header terminal control removed from the current release/13.6 implementation.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Documents Aspire 13.6 terminal experiences across the dashboard, AppHost APIs, CLI automation, and integration REPLs.
Changes:
- Adds focused terminal, interaction, automation, and tape-playback guides.
- Consolidates six integration REPL sections.
- Updates CLI references, navigation, cross-links, and redirects.
| File | Description |
|---|---|
reference/cli/commands/aspire-terminal.mdx |
Adds tape command coverage. |
reference/cli/commands/aspire-terminal-tape.mdx |
Documents the tape command group. |
reference/cli/commands/aspire-terminal-tape-play.mdx |
Documents tape playback options and output. |
reference/cli/commands/aspire-terminal-ps.mdx |
Adds terminal guide links. |
reference/cli/commands/aspire-terminal-attach.mdx |
Adds terminal guide links. |
integrations/databases/sql-server/sql-server-host.mdx |
Consolidates SQL Server REPL guidance. |
integrations/databases/postgres/postgres-host.mdx |
Consolidates PostgreSQL REPL guidance. |
integrations/databases/mysql/mysql-host.mdx |
Consolidates MySQL REPL guidance. |
integrations/databases/mongodb/mongodb-host.mdx |
Consolidates MongoDB REPL guidance. |
integrations/caching/valkey/valkey-host.mdx |
Consolidates Valkey REPL guidance. |
integrations/caching/redis/redis-host.mdx |
Consolidates Redis REPL guidance. |
fundamentals/custom-resource-commands.mdx |
Links commands to terminal workflows. |
extensibility/interaction-service.mdx |
Updates terminal interaction coverage. |
diagnostics/aspireterminal001.mdx |
Expands diagnostic API coverage. |
dashboard/terminals.mdx |
Adds the terminal overview and usage guide. |
dashboard/terminal-tape-playback.mdx |
Adds tape automation guidance. |
dashboard/terminal-interactions.mdx |
Adds terminal-dialog guidance and examples. |
dashboard/standalone.mdx |
Clarifies standalone limitations. |
dashboard/overview.mdx |
Adds terminals to dashboard features. |
dashboard/explore.mdx |
Updates terminal cross-references. |
dashboard/ephemeral-terminals.mdx |
Documents AppHost-owned terminals. |
dashboard/automate-terminals.mdx |
Documents programmatic automation. |
app-host/with-terminal.mdx |
Expands resource-terminal documentation. |
config/sidebar/reference.topics.ts |
Adds tape CLI pages. |
config/sidebar/docs.topics.ts |
Removes the old terminal entry. |
config/sidebar/dashboard.topics.ts |
Adds the terminal feature group. |
config/redirects.mjs |
Redirects moved terminal guides. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Remove references to the header control removed in Aspire 13.6 and document the backtick shortcut in both dashboard guides. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Mitch Denny (mitchdenny)
merged commit Sep 29, 2026
89e0903
into
release/13.6
27 of 30 checks passed
Mitch Denny (mitchdenny)
deleted the
mitchdenny-dashboard-terminal-documentation
branch
September 29, 2026 07:32
David Pine (IEvangelist)
added a commit
that referenced
this pull request
Sep 29, 2026
Completes the in-progress `aspire-13-6.mdx` draft by adding the remaining "Ship Mode" / changelog highlights, without removing any previously approved content. ## What's added - **Dashboard:** Native AOT standalone dashboard + Fluent UI Blazor v5 refresh. - **Integrations:** docked database/cache REPLs (`WithRepl()`), remote Foundry Local services (`RunAsFoundryLocal(endpoint)`), Cosmos DB emulator OpenTelemetry. - **App model:** multithreaded coordinated builds, Project V2 migration skill for agents. - **CLI:** pin the CLI via a local tool manifest (`AspireCliInvocationMode`), MCP config now opt-in in `aspire new`/`init`. - **VS Code:** outdated-CLI warning. - Reworked the "This release introduces" list into a high-level summary rather than a section-by-section table of contents. ## Update: TODOs and review feedback addressed - **Merged `release/13.6`** (42 commits, including #1780 and #1684). When resolving conflicts, I kept this PR's summary list and emoji headings and took the release branch's corrected facts: .NET project graduation, `-mt` SDK requirements, and the Blazor gateway publish support. I kept the Project V2 migration skill and Remote Foundry Local bullets. - **All TODOs resolved; the article now has none:** - Connector Namespace (#1781): links to `/integrations/cloud/azure/azure-connector-namespace/`. - Connection-string naming (#1782): links to `/fundamentals/environment-variables/#migrating-connection-string-consumers`. - Foundry Toolbox (#1628): links to the Toolbox walkthrough. - Docked REPLs (#1777): links to the per-integration **Open an interactive REPL** sections. The six REPL anchors were broken (`#add-*-with-a-repl-command`) and are fixed to `#open-an-interactive-repl`. - Java (@marshalhayes): added an `addSpringBootApp` / `AddSpringBootApp` sample, taken from the package README. - Rust (@afscrome): used the reviewer's `addRustApp(...).withHttpEndpoint({ env: 'PORT' })` sample. - **Twoslash:** every TypeScript AppHost fence is now `twoslash`. New TypeScript-first tabs cover `withRepl`, `withTerminal`, `addRustApp`, `addSpringBootApp`, `withBuildEnvironment`, `addDenoApp`, and `addToolbox`. - **Preview note:** added a "Prerelease packages" note. Java, Rust, Connector Namespace, and Sandboxes ship as `13.6.0-preview.1`. - **Deno bullet:** now accurately says `AddDenoApp` is experimental (`ASPIREDENO001`) and distinct from the Community Toolkit Deno integration. - **API vetting:** all 45 API names in the article are verified against microsoft/aspire `release/13.6` @ `f4c27f2d`. `WithRepl` comes from microsoft/aspire#20419 and exists on Redis, Valkey, PostgreSQL, MySQL, SQL Server, and MongoDB. **Validation** was run against this branch plus the #1787 13.6.0 API data: - `twoslash-blocks` passes. A negative control (`withReplz`, `addSpringBootAppz`) fails with TS2551 as expected. - 59 API-reference and SEO tests pass. - All internal links and anchors in the article resolve. > [!IMPORTANT] > Merge #1787 first. The new Twoslash blocks need its regenerated 13.6.0 types (`withRepl`, Java, Rust). --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Copilot-Session: 829e510d-2b06-4301-9759-3bd760c45e5c
5 tasks
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
Related to #1663. Targets
release/13.6.Source, and clarify ownership and Docker exec cleanup.Publication dependencies
This remains a draft for Aspire 13.6.
mainpaths as requested. On September 29, Upgrade all samples to Aspire 13.6.0 aspire-samples#1980 was still open andsamples/terminalswas not onmain. Merge that sample PR before publishing these docs. Sample excerpts were checked against PR head749fed3693d397081753c2ec2539c155dd88155f.https://aka.ms/aspire/dashboard-terminalsstill redirects to Bing; authorized provisioning is needed before release.twoslashwhile the catalog lacks the complete surface; this does not block the editorial merge.Third-party links and affiliations
Links to the Charmbracelet VHS syntax reference,
mitchdenny/hex1bcompatibility documentation, and a Docker/Moby issue. The Hex1b repository is hosted under the PR author's GitHub account. No affiliation with Charmbracelet or Docker/Moby has been declared. Source and sample links point tomicrosoft/aspireandmicrosoft/aspire-samples.Validation
September 29 release reconciliation (
ff7839b6):release/13.6at5589ce6d, resolved the security-doc conflict, and consolidated six auto-merged duplicate REPL sections.git diff --checkpassed.Earlier editorial/source review confirmed the rqlite excerpts, all six
WithReplmethods and TypeScript exports, Dashboard topic continuity, and the section-level Preview badge. This was not a fresh runtime execution of every example.Earlier matching-staging runtime validation used isolated Aspire CLI
13.6.0+34db30a7d3733229da64a403dfc4e4e4d7a1a43band matching packages:PONG; C# clean exit and reopening passed.ASPIRE_TAPE_ready; headless automation returnedReceived:hello; number guessing completed withFound 7 in 6 guesses.No local production build; CI covers production build and broader site checks.
Fixes: #1663