Install Aspire CLI

Aspire includes tooling to help you create and configure cloud-native apps. The tooling includes useful starter project templates and other features to streamline getting started with Aspire for Visual Studio, Visual Studio Code, and CLI workflows.

This article teaches you how to install the Aspire CLI, which is a CLI tool used to manage your Aspire solutions.

Prerequisites

• .NET SDK 9.0.

Install as a native executable

The compiled version of the Aspire CLI can be installed using the Aspire CLI installation script. The script is available for PowerShell and Bash.

1. Open a terminal.

2. Download the script and save it as a file:

   Bash

   curl -sSL https://aspire.dev/install.sh -o aspire-install.sh

   PowerShell

   Invoke-RestMethod https://aspire.dev/install.ps1 -OutFile aspire-install.ps1

3. Run the script to install the stable release build of Aspire.

   You should see output similar to the following snippet:

   Output

   Downloading from: https://aka.ms/dotnet/9/aspire/ga/daily/aspire-cli-win-x64.zip
   Aspire CLI successfully installed to: C:\Users\name\.aspire\bin\aspire.exe
   Added C:\Users\username\.aspire\bin to PATH for current session
   Added C:\Users\username\.aspire\bin to user PATH environment variable
   
   The aspire cli is now available for use in this and new sessions.

For more information about the install script, see aspire-install script reference.

Tip

You can download and run the script in a single command:

Bash

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

PowerShell

Invoke-Expression "& { $(Invoke-RestMethod https://aspire.dev/install.ps1) }"

See aspire-install script reference for more information about available flags.

Install as a .NET global tool

Use the dotnet tool command to install the Aspire CLI global tool. The name of the global tool is Aspire.Cli.

1. Open a terminal.

2. Run the following command to install Aspire CLI:

   .NET CLI

   dotnet tool install -g Aspire.Cli --prerelease

Validation

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

Aspire CLI

aspire --version

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

Aspire CLI — Output

13.0.0

Note

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