Document Aspire CLI npm install method#1142
Merged
Merged
Conversation
Document npm distribution of the Aspire CLI (@microsoft/aspire-cli), added in microsoft/aspire#17297: - Add an "Install with npm" section to the install guide. - Document install-aware `aspire update --self` behavior, including the npm update guidance the CLI prints. - Note the npm install option in the 13.4 what's new page. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents the new npm-based Aspire CLI distribution for Aspire 13.4 and clarifies how CLI self-updates behave based on installation source.
Changes:
- Adds npm installation guidance to the CLI install page.
- Documents npm-aware
aspire update --selfbehavior. - Updates Aspire 13.4 release notes to mention the npm install option and update command behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/frontend/src/content/docs/get-started/install-cli.mdx |
Adds npm installation instructions and npm self-update note. |
src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx |
Explains install-source-specific CLI update behavior. |
src/frontend/src/content/docs/whats-new/aspire-13-4.mdx |
Adds npm CLI install/update notes to the 13.4 release documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Clarify that `aspire update --self` prints the package-manager command for npm and .NET tool installs instead of replacing a managed binary. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
adamint
commented
May 31, 2026
sebastienros
reviewed
Jun 1, 2026
| ``` | ||
|
|
||
| - When the CLI was installed as a **.NET tool**, the command prints the `dotnet tool update` command to run. | ||
| - Otherwise, `aspire update --self` downloads and installs the latest CLI binary directly. |
Contributor
There was a problem hiding this comment.
It feels weird to make it the third and unnamed option. I would relegate the dotnet tool one at the end, and give this one a name "install script" or "binary install"
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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 the npm distribution of the Aspire CLI added in microsoft/aspire#17297. Targeting
release/13.4since the npm packages ship as part of the 13.4 release.The PR adds
@microsoft/aspire-cli(a pointer package plus RID-specific packages) and makesaspire update --selfnpm-aware, so the docs need to cover the new install path and the update behavior.Changes
get-started/install-cli.mdx— new "Install with npm" section (npm install -g @microsoft/aspire-cli), Node.js prerequisite, cross-platform note, and the npm self-update behavior. Updated the frontmatter SEO title/description, which still referenced a ".NET tool" method the page no longer documents.reference/cli/commands/aspire-update.mdx— documents howaspire update --selfadapts to the install source (npm vsdotnet toolvs direct binary). The npm output text matches what the CLI actually prints (npm install -g @microsoft/aspire-cli@latest).whats-new/aspire-13-4.mdx— notes npm as an install option in the upgrade section and a CLI bullet.Notes
NpmInstallDetection.GetNpmUpdateCommand(@latest), not the loosernpm update -gwording in the source PR description.Validation
/i18npage, which needs full git history (shallow clone).