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. You can install the CLI with the install script, .NET global tool, or npm. Use the install script for the fastest setup, or choose the package manager that matches your AppHost language.

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

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.

Install for your AppHost language

The install script works for all AppHost languages. If you prefer to manage the Aspire CLI with a language-specific package manager, use the option that matches your AppHost project:

C#

Use the .NET global tool when you want to manage the Aspire CLI with the .NET SDK in a C# AppHost project. This option requires the .NET SDK.

To install the latest stable release globally, run:

Install with .NET global tool

dotnet tool install -g Aspire.Cli

TypeScript

Starting with Aspire 13.4, install the Aspire CLI from npm if you already manage developer tooling with npm or work in a TypeScript AppHost project. This option requires Node.js.

To install the latest stable release globally, run:

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.

Note

When you install from npm, the Aspire CLI routes self-updates through npm. Running aspire update --self prints the npm install -g @microsoft/aspire-cli@latest command to run rather than downloading a new binary directly. For more information, see aspire update.

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
• aspire command reference
• Aspire VS Code extension — install the CLI and use Aspire commands from within VS Code