Skip to content

[docs] Document CLI bundle default for C# AppHost templates #2137

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 2 commits into
base: release/17.0
Choose a base branch
from
+1 −1
Open

[docs] Document CLI bundle default for C# AppHost templates #2137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bae39c
Document CLI bundle default in templates
aspire-repo-bot[bot] Nov 12, 2026
ccf492e
Clarify AspireUseCliBundle default for C# AppHosts
eerhardt Nov 12, 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
2 changes: 1 addition & 1 deletion 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 @@ -105,7 +105,7 @@ The Aspire SDK can source the binaries for these dependencies from platform-spec

When it uses the Aspire CLI bundle, those binaries update when you update the Aspire CLI through [`aspire update --self`](/reference/cli/commands/aspire-update/). Without the bundle, the Aspire SDK version used by the AppHost determines the binaries by adding implicit references to the RID-specific `Aspire.Hosting.Orchestration.*` and `Aspire.Dashboard.Sdk.*` packages.

New C# AppHost projects created with `aspire new` or `dotnet new`, and new single-file AppHosts created with `aspire init`, set `AspireUseCliBundle` to `true` automatically. For existing AppHosts, set `AspireUseCliBundle` to `true` to enable the CLI bundle. We recommend enabling it now because the CLI bundle will become the only supported source for orchestration dependencies in an upcoming Aspire release. The SDK property currently defaults to `false`, so launching a C# AppHost with `dotnet run` or an IDE continues to work without requiring the Aspire CLI. Leaving it unset (or explicitly `false`) reports warning [`ASPIRE010`](/diagnostics/aspire010/) as a reminder that some Aspire features require the bundle; suppress it if you intend to keep using NuGet-restored orchestration dependencies.
Current C# AppHost SDKs default `AspireUseCliBundle` to `true`, enabling the bundle without an explicit project setting. Set it to `false` to use NuGet-restored orchestration dependencies; this reports warning [`ASPIRE010`](/diagnostics/aspire010/). On older SDKs, set it to `true` to enable the bundle.

When `AspireUseCliBundle` is `true`:

Expand Down
Loading