Repository navigation
[docs] Document CLI bundle default for C# AppHost templates - #2137
Open
aspire-repo-bot[bot] wants to merge 2 commits into
Open
aspire-repo-bot[bot] wants to merge 2 commits into
aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
aspire-repo-bot
Bot
added
the
docs-from-code
4 of 14 tasks
Contributor
Author
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>
Eric Erhardt (eerhardt)
marked this pull request as ready for review
November 12, 2026 23:35
Eric Erhardt (eerhardt)
requested a review
from David Pine (IEvangelist)
as a code owner
November 12, 2026 23:35
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation incorrectly recommends disabling AspireUseCliBundle, which causes current C# AppHosts to fail with ASPIRE013 rather than use a NuGet fallback.
1 open issue
What changed in this PR
Updates the Aspire SDK getting-started documentation to describe the CLI bundle as enabled by default for current C# AppHost SDKs.
Changes:
- Replaces the previous opt-in guidance with default-enabled behavior.
- Revises guidance for disabling the bundle and enabling it on older SDKs.
| File | Description |
|---|---|
src/frontend/src/content/docs/get-started/aspire-sdk.mdx |
Updates the CLI bundle default and configuration guidance. |
Review effort: Balanced
| 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. |
David Pine (IEvangelist)
requested review from
Damian Edwards (DamianEdwards)
and removed request for
David Pine (IEvangelist) and
Mitch Denny (mitchdenny)
November 12, 2026 23:54
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.
Documents changes from microsoft/aspire#21986
Author:
@DamianEdwards(PR author per source PR; please verify)Target branch: Targeting
release/17.0— the latest release branch onmicrosoft/aspire.dev— becauserelease/17.1(from the source PR milestone17.1) does not exist there.Why: The source PR removes the redundant
AspireUseCliBundleopt-in from project/single-file templates andaspire init, since current SDKs enable the CLI bundle by default. CLI generation still emits it for SDK versions before 17.0 and 17.0.0 prereleases. An inheritedAspireUseCliBundle=falsenow takes effect and the SDK reports ASPIRE013. Signals:project_template_changed,cli_command_file_changed,pr_body_has_cli_flag_mention.Changes (updated page):
src/frontend/src/content/docs/get-started/aspire-sdk.mdx: updated the CLI bundle section to describe the new default and templates behavior.SME should confirm the ASPIRE013 wording and whether the ASPIRE010 page needs further changes.