Skip to content

[docs] Default Aspire CLI bundle opt-in in new C# AppHost templates #1483

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

Open
aspire-repo-bot wants to merge 1 commit into
base: release/13.5
Choose a base branch
from
+16 −0
Open

[docs] Default Aspire CLI bundle opt-in in new C# AppHost templates #1483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions src/frontend/src/content/docs/get-started/aspire-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ Today, the Aspire SDK restores the binaries for these dependencies from platform

Aspire is moving toward using the installed **Aspire CLI bundle** as the source for those orchestration dependencies. With this model, those binaries update when you update the Aspire CLI through [`aspire update --self`](/reference/cli/commands/aspire-update/) instead of being tied to RID-specific `Aspire.Hosting.Orchestration.*` and `Aspire.Dashboard.Sdk.*` package references in each AppHost project.

New C# AppHost projects created with `aspire new` or `dotnet new`, and single-file AppHosts created with `aspire init`, opt in to `AspireUseCliBundle` by default. Existing AppHost projects need to set it explicitly to opt in during the transition before this behavior becomes the default for all AppHosts.

Set `AspireUseCliBundle` to `true` to opt in during the transition before this behavior becomes the default.

Comment on lines +111 to 114
When `AspireUseCliBundle` is `true`:
Expand All @@ -129,6 +131,12 @@ Set `AspireUseCliBundle` in your AppHost `.csproj`:
</PropertyGroup>
```

For a single-file AppHost created with [`aspire init`](/reference/cli/commands/aspire-init/), set the equivalent `#:property` directive:

@adamint Adam Ratzman (adamint) Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could this say For an existing single-file AppHost? The paragraph above says new aspire init AppHosts already opt in, so this currently reads like users need to add a directive that aspire init just generated.


```csharp title="apphost.cs"
#:property AspireUseCliBundle=true
```

:::note[Advanced scenario: Override the bundle path]
Most apps don't need to set the CLI bundle path. If the Aspire CLI isn't on `PATH`, provide an explicit path using `AspireCliBundlePath` (path to the CLI bundle directory) or `AspireCliPath` (path to the `aspire` executable):

Expand Down
8 changes: 8 additions & 0 deletions src/frontend/src/content/docs/whats-new/aspire-13-5.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,14 @@ The Aspire CLI is now available as an npm package (`@microsoft/aspire-cli`), pro
- **TypeScript AppHosts honor --no-build**: TypeScript AppHosts now correctly skip the TypeScript compilation check when the --no-build flag is passed.
- **CLI shutdown responsiveness**: Multiple improvements to Ctrl+C/SIGTERM handling, including faster signal responsiveness during AppHost startup.

## 📦 Aspire CLI bundle enabled by default in new C# AppHost templates

New C# AppHost projects and single-file AppHosts created with `aspire new`, `dotnet new`, or `aspire init` now set `AspireUseCliBundle` to `true` automatically, so they use the installed Aspire CLI bundle for DCP and Dashboard orchestration dependencies without an opt-in warning. Existing AppHost projects are unaffected and can opt in manually.

<LearnMore>
For setup details, see [Use the Aspire CLI bundle for orchestration dependencies](/get-started/aspire-sdk/#use-the-aspire-cli-bundle-for-orchestration-dependencies) in the Aspire SDK documentation.
</LearnMore>

## 📊 Dashboard and telemetry improvements

- **Timestamp filter for telemetry**: Filter logs and traces by timestamp using a dedicated search qualifier in the Dashboard filter dialog.
Expand Down
Loading