Skip to content

docs: document running the Aspire CLI via npm/npx#1239

Open
IEvangelist wants to merge 4 commits into
mainfrom
ievangelist/cli-npm-install-docs
Open

docs: document running the Aspire CLI via npm/npx#1239
IEvangelist wants to merge 4 commits into
mainfrom
ievangelist/cli-npm-install-docs

Conversation

@IEvangelist

Copy link
Copy Markdown
Member

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 with npx and no separate install:

npx -y @microsoft/aspire-cli dashboard run

This PR documents the npm package and npx usage across the install and dashboard docs.

Changes

  • get-started/install-cli.mdx — adds a Use the npm package section covering zero-install npx usage and the npm install -g alternative, 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 the npx command. (The Node.js and Python standalone tutorials delegate here, so they pick it up automatically.)
  • reference/cli/commands/aspire-dashboard-run.mdx — adds the same npx tip 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.

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>
Copilot AI review requested due to automatic review settings June 9, 2026 12:49
Comment thread src/frontend/src/content/docs/dashboard/standalone.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-dashboard-run.mdx Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 npx and npm install -g flows.
  • Add a Run without installing tip to the standalone dashboard page.
  • Add the same Run without installing tip to the aspire dashboard run command 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.

Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-dashboard-run.mdx Outdated
Comment thread src/frontend/src/content/docs/dashboard/standalone.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/install-cli.mdx Outdated
IEvangelist and others added 2 commits June 9, 2026 07:55
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1239. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1239 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@davidfowl

Copy link
Copy Markdown
Contributor

#1243 😄

</TabItem>
</Tabs>

## Run with npx without installing

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants