Skip to content

Update Aspire VS Code dashboard docs #1323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamint merged 2 commits into from
Jul 3, 2026
+5 −14
Merged

Update Aspire VS Code dashboard docs #1323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b89757d
Update Aspire VS Code dashboard docs
adamint Jul 1, 2026
2c1a5fa
Potential fix for pull request finding
adamint Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,7 @@ When an AppHost is running, the extension paints live state directly into your e

**Editor title bar buttons** add **Run Aspire AppHost** and **Debug Aspire AppHost** actions next to the standard Run/Debug buttons whenever you have an AppHost file open.

**Health-aware gutter decorations** provide an at-a-glance view of resource health and state without cluttering the editor with text using the following shapes and colors:

| Icon | Meaning |
|------|---------|
| ✓ (green checkmark) | Running and healthy |
| ⊙ (grey circle with check) | Completed — exited cleanly (exit code 0) |
| ⚠ (yellow triangle with `!`) | Running but unhealthy (health checks failing) |
| ✕ (red X) | Failed to start, exited with a non-zero exit code, or runtime unhealthy |
| ⌛ (blue hourglass) | Starting, stopping, building, or waiting |
| ○ (grey hollow circle) | Not yet started |
**Health-aware gutter decorations** provide an at-a-glance view of resource health and state without cluttering the editor with text.

<ThemeImage
dark={sidebarTree}
Expand All @@ -100,6 +91,10 @@ Each resource shows its type, state, health summary, and exit code, plus a healt

## Run, debug, and deploy

:::note[Debugging]
The Aspire Dashboard is no longer opened by default when the AppHost starts, as most operations can be performed using the Aspire view inside VS Code. To launch the dashboard, use the **Open Dashboard** CodeLens, the **Aspire: Open Dashboard** command, or open it from the Aspire view.
:::
Comment thread
Copilot marked this conversation as resolved.

**Aspire: Configure launch.json file** adds a minimal launch configuration `.vscode/launch.json` that supports AppHosts written in any language. AppHosts are discovered automatically in the workspace.

<LearnMore>
Expand Down Expand Up @@ -160,10 +155,6 @@ Finally, you can specify `env` and `args` to set environment variables and comma
For more information, see [Aspire publishing and deployment overview](/deployment/deploy-with-aspire/).
</LearnMore>

## Dashboard from VS Code

By default, the dashboard opens automatically when the AppHost starts. You can also open it from the Aspire view if you closed the browser tab and want it back.

## Language coverage

The extension detects each resource's language and attaches the right debugger:
Expand Down
Loading