Skip to content

[docs] Document automatic CLI bundle setup recovery #1496

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
+2 −1
Open

[docs] Document automatic CLI bundle setup recovery #1496

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
3 changes: 2 additions & 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 @@ -117,7 +117,8 @@ When `AspireUseCliBundle` is `true`:
- At build time, the SDK resolves the DCP and Dashboard executables in this priority order:
1. Explicit `AspireCliBundlePath` / `AspireCliPath` properties in the project file.
2. The `aspire` executable on `PATH`.
- If the bundle cannot be found, the build emits error `ASPIRE009` with a message directing you to [get.aspire.dev](https://get.aspire.dev) to install the Aspire CLI.
- If the resolved Aspire CLI has a bundle that hasn't been extracted yet, the build runs `aspire setup` through the selected `aspire` (or paired `dnx`) invocation to extract it, then resolves the bundle again. This recovers installations that didn't run the release install scripts, so an AppHost can build and launch directly from an IDE without first running an Aspire CLI command.
- If the bundle still cannot be found or resolved after setup runs, the build emits error `ASPIRE009` with a message directing you to [get.aspire.dev](https://get.aspire.dev) to install the Aspire CLI.
Comment on lines 117 to +121

#### Enable the opt-in

Expand Down
Loading