Edit

Share via


Install .NET Aspire CLI

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

Prerequisites

Install as a native executable

The compiled version of the Aspire CLI can be installed using the Aspire CLI installation script.

To install the Aspire CLI, run the following command in your terminal:

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

Script options

The Unix install script (install.sh) supports the following options:

Parameter Short form Description Default value
--install-path -i Directory to install the CLI $HOME/.aspire/bin
--version Version of the Aspire CLI to download 9.4
--quality -q Quality to download (dev, staging, release) release
--os Operating system (auto-detected if not specified) auto-detect
--arch Architecture (auto-detected if not specified) auto-detect
--keep-archive -k Keep downloaded archive files after installation false
--verbose -v Enable verbose output false
--help -h Show help message

Quality options

The --quality option determines which build of the Aspire CLI to install:

  • dev: Latest builds from the main branch (development builds).
  • staging: Builds from the current release branch (pre-release builds).
  • release: Latest generally available release (stable builds).

Usage examples

Install to a custom directory:

curl -sSL https://aspire.dev/install.sh | bash -s -- --install-path "/usr/local/bin"

Install with verbose output:

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

Install a specific version:

curl -sSL https://aspire.dev/install.sh | bash -s -- --version "9.4"

Install development builds:

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

Default installation path

The script installs the Aspire CLI to $HOME/.aspire/bin by default.

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