Edit

Share via

Install Aspire CLI

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

Prerequisites

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:

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

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

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

    You should see output similar to the following snippet:

    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:

Windows:

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

macOS/Linux:

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

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:

    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 --version

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

9.4.0

See also