Install Aspire CLI

Aspire provides a command-line interface (CLI) tool to help you create and manage Aspire-based apps. The CLI streamlines your development workflow with an interactive-first experience. This guide shows you how to install the Aspire CLI on your system. Choose the package manager that fits your environment — Homebrew, npm, NuGet, WinGet, or mise — or use the install script for direct setup.

Using VS Code?

The Aspire VS Code extension can install the CLI for you. From the Command Palette, run:

Command Palette

> Aspire: Install Aspire CLI (stable)

Before installing the Aspire CLI, ensure you have the required prerequisites set up.

Install with a package manager

Install the Aspire CLI with a package manager to manage it alongside your other developer tooling. Choose the option that fits your environment:

Homebrew

Install the Aspire CLI with Homebrew on macOS (Apple silicon and Intel).

Install with Homebrew

brew install --cask microsoft/aspire/aspire

npm

Install the Aspire CLI from npm when you manage developer tooling with npm. This option requires Node.js.

Install with npm

npm install -g @microsoft/aspire-cli

The same command works on Windows, macOS, and Linux (including musl-based distributions such as Alpine). npm selects the correct native binary for your operating system and architecture automatically.

To update an npm-based install, run:

Update with npm

npm install -g @microsoft/aspire-cli@latest

Note

When you install from npm, the Aspire CLI routes self-updates through npm. Running aspire update --self prints the npm update command rather than downloading a new binary directly. For more information, see aspire update.

NuGet

Install the Aspire CLI as a .NET global tool when you manage developer tooling with the .NET SDK. This option requires the .NET SDK.

Install with the .NET CLI

dotnet tool install -g Aspire.Cli

The CLI is published to NuGet.org as the Aspire.Cli global tool and works on Windows, macOS, and Linux.

WinGet

Install the Aspire CLI with the Windows Package Manager (WinGet) on Windows (x64 and Arm64).

Install with WinGet

winget install Microsoft.Aspire

mise

Install the Aspire CLI with mise when you manage developer tooling with a shared tool version manager. The Aspire CLI is available from the mise registry as aspire.

Install with mise

mise use -g aspire

Install with the install script

Download and run the installation script in a single command:

Bash

Install script (macOS/Linux)

curl -sSL https://aspire.dev/install.sh | bash

PowerShell

Install script (Windows)

irm https://aspire.dev/install.ps1 | iex

The script installs the latest stable release of Aspire CLI. During installation, you might be asked Do you want to continue?. Reply with Y for Yes or A for Yes to All to continue downloading and running the install script. See Validation to verify the installation.

Tip

At any time, you can reopen the Install Aspire CLI command modal from the top navigation (download icon ). The modal shows the download-and-install command for your OS, so you can run the installer again when needed.

You only need to download the script separately if you want to inspect it or run the installer as separate commands. For more information, see the aspire-install script reference.

Validation

To validate that the Aspire CLI is installed, use aspire --version to query Aspire CLI for a version number:

Check installed version

aspire --version

If that command works, you’re presented with the version of the Aspire CLI tool:

Aspire CLI — Output

13.4.0+{commitSHA}

The +{commitSHA} suffix indicates the specific commit from which the Aspire CLI was built.

Learn more by reading the Aspire CLI reference documentation.

Troubleshooting

If you’re not seeing a version number, it’s possible that your terminal session needs to be restarted to pick up the changes to your PATH environment variable. Simply close and reopen your terminal, then try running the aspire --version command again.

See also

• aspire-install script reference
• @microsoft/aspire-cli on npm — run the CLI with npm or npx
• aspire command reference
• Aspire VS Code extension — install the CLI and use Aspire commands from within VS Code