[docs] Add Nix installation path for Aspire CLI#1286
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
[docs] Add Nix installation path for Aspire CLI#1286aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Documents the first-party Nix flake for the Aspire CLI introduced in microsoft/aspire#18410: - Adds a 'Nix' tab to the Install CLI package manager section, with nix run, nix profile add, and flake.nix usage examples - Updates the 'aspire update --self' section to describe how Nix installs print profile/flake update guidance instead of a binary download Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
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. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new Nix-based installation and update experience for the Aspire CLI (introduced in microsoft/aspire#18410), including guidance for Nix profiles and flake consumers, and describes how aspire update --self behaves under Nix installs.
Changes:
- Added a new Nix install tab to the CLI installation guide with
nix run,nix profile add, and aflake.nixconsumer example. - Extended
aspire update --selfdocumentation to include the Nix install case and its Nix-specific update guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/get-started/install-cli.mdx | Adds Nix as a documented package-manager install path (including a flake consumer example). |
| src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx | Documents Nix-aware aspire update --self messaging and recommended Nix update commands. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| nix profile add github:microsoft/aspire#aspire-cli | ||
| ``` | ||
|
|
||
| To use the Aspire CLI in a project's `flake.nix`, consume the package output directly or apply the overlay: |
Comment on lines
+128
to
+130
| system = "x86_64-linux"; | ||
| pkgs = nixpkgs.legacyPackages.${system}; | ||
| in |
Comment on lines
+82
to
+83
| - When the CLI was installed via **Nix** (profile or flake), the command prints the Nix update commands to run instead of downloading a new binary. Because the Nix store is read-only, in-place binary updates are not possible: | ||
|
|
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#18410 by
@davidfowl.Targeting
release/13.5based on the source PR milestone13.5(exact match on microsoft/aspire.dev).Why this PR is needed
microsoft/aspire#18410 added a first-party Nix flake (
flake.nix) that packages the Aspire CLI for Nix and NixOS users. Two user-facing changes need docs coverage:New Nix install path — users can now run
nix run github:microsoft/aspire#aspire-cli, add the CLI to their profile withnix profile add, or consume the package from their ownflake.nix. This is an entirely new installation method not previously documented.Nix-aware
aspire update --self— when the CLI detects it was installed from Nix (via the.aspire-install.jsonsidecar's"source":"nix"field), it prints Nix-specific update guidance instead of attempting an in-place binary download (which would fail because the Nix store is read-only).Changes made
src/frontend/src/content/docs/get-started/install-cli.mdx(updated)Nixtab to the "Install with a package manager"<Tabs>block with:nix runfor ephemeral usenix profile addfor persistent profile installflake.nixconsumer example showing the package output approacheng/nix/versions.json)aspire update --selfbehaviour with a link to the update referencesrc/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx(updated)NixSelfUpdateMessage) and the two commands users should run (nix profile upgrade aspire-cli/nix flake update <input-name>).Files modified
src/frontend/src/content/docs/get-started/install-cli.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx