docs: document running the Aspire CLI via npm/npx#1239
Conversation
The Aspire CLI is now published to npm as @microsoft/aspire-cli, so users can run any command (for example, the standalone dashboard) with npx and no install. Document the npm package and npx usage on the CLI install page, the standalone dashboard guide, and the aspire dashboard run command reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Documents using the new @microsoft/aspire-cli npm package to run Aspire CLI commands via npx, specifically highlighting “run without installing” scenarios for the standalone dashboard and CLI reference.
Changes:
- Add an Use the npm package section to the CLI install guide, including
npxandnpm install -gflows. - Add a Run without installing tip to the standalone dashboard page.
- Add the same Run without installing tip to the
aspire dashboard runcommand reference.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/get-started/install-cli.mdx | Adds npm/npx installation and usage guidance plus a “See also” link to npm. |
| src/frontend/src/content/docs/dashboard/standalone.mdx | Adds an npx-based “run without installing” tip to the CLI startup path. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-dashboard-run.mdx | Adds an npx-based “run without installing” tip after the synopsis. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
|
#1243 😄 |
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Run with npx without installing |
There was a problem hiding this comment.
I'm not sure this makes sense to show here as its about running with the standalone dashboard.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Summary
The Aspire CLI is now published to npm as
@microsoft/aspire-cli. With Node.js installed, users can run any Aspire command (for example, the standalone dashboard) directly withnpxand no separate install:This PR documents the npm package and
npxusage across the install and dashboard docs.Changes
get-started/install-cli.mdx— adds a Use the npm package section covering zero-installnpxusage and thenpm install -galternative, plus a See also link to the npm package.dashboard/standalone.mdx— adds a Run without installing tip under the Aspire CLI startup option with thenpxcommand. (The Node.js and Python standalone tutorials delegate here, so they pick it up automatically.)reference/cli/commands/aspire-dashboard-run.mdx— adds the samenpxtip after the synopsis.All commands are cross-platform, so plain titled code blocks are used rather than OS-aware tabs. No Aspire version is referenced since this capability has shipped.