Install script

This article contains the syntax of the aspire install PowerShell and Bash scripts. To download the script, see Install as a native executable.

Name

aspire-install.ps1 | aspire-install.sh - Scripts used to install the Aspire CLI.

Synopsis

Bash

Bash

aspire-install.sh
  [--install-path <DIRECTORY>]
  [--version <VERSION>]
  [--quality <QUALITY>]
  [--os <OPERATING_SYSTEM>]
  [--arch <ARCHITECTURE>]
  [--keep-archive]
  [--verbose]
  [--help]

PowerShell

PowerShell

aspire-install.ps1
  [-InstallPath <DIRECTORY>]
  [-Version <VERSION>]
  [-Quality <QUALITY>]
  [-OS <OPERATING_SYSTEM>]
  [-Architecture <ARCHITECTURE>]
  [-KeepArchive]
  [-Help]"

Description

The aspire-install scripts perform a nonadmin installation of the Aspire CLI.

Note

The Aspire CLI is still in preview and under active development.

Script behavior

Both scripts behave the same way. They download the Aspire CLI for the target platform, install it to the specified location, and add it to your PATH environment variable.

By default, the installation scripts download and install the latest stable release of the Aspire CLI. Specify a different version with the -Version|--version argument or a different quality level with the -Quality|--quality argument.

Unless changed with the -InstallPath|--install-path argument, the script installs to a user-specific location: %USERPROFILE%\.aspire\bin on Windows or $HOME/.aspire/bin on Linux/macOS.

Options

• -InstallPath|--install-path <DIRECTORY>

  Specifies the installation path. The directory is created if it doesn’t exist. The default value is %USERPROFILE%.aspire\bin on Windows and $HOME/.aspire/bin on Linux/macOS. The Aspire CLI executable is placed directly in this directory.

• -Version|--version <VERSION>

  Represents a specific version to install. For example: 9.4. If not specified, the latest stable version is installed.

• -Quality|--quality <QUALITY>

  Downloads the specified quality build. The possible values are:

  • release: The latest stable release (default).
  • staging: Builds from the current release branch (prerelease builds).
  • dev: Latest builds from the main branch (development builds).

  The different quality values signal different stages of the release process:

  • release: The final stable releases of the Aspire CLI. Intended for production use.
  • staging: Prerelease builds intended for testing upcoming releases. Not recommended for production use.
  • dev: The latest builds from the main development branch. They’re built frequently and aren’t fully tested. Not recommended for production use but can be used to test specific features or fixes immediately after they’re merged.

• -OS|--os <OPERATING_SYSTEM>

  Specifies the operating system for which the CLI is being installed. Possible values are: win, linux, linux-musl, osx.

  The parameter is optional and should only be used when it’s required to override the operating system that is detected by the script.

• -Architecture|--arch <ARCHITECTURE>

  Architecture of the Aspire CLI binaries to install. Possible values are x64, x86, arm64. The default behavior is to autodetect the current system architecture.

• -KeepArchive|--keep-archive

  If you set this option, the script keeps the downloaded archive files and temporary directory after installation. By default, the script deletes the archive after extraction and cleans up the temporary directory.

• --verbose

  Displays diagnostics information. (Linux/macOS only)

• -Help|--help

  Prints help information for the script.

Examples

• Install the latest stable version to the default location:

  Bash

  ./aspire-install.sh

  PowerShell

  .\aspire-install.ps1

• Install to a custom directory:

  Bash

  ./aspire-install.sh --install-path "/usr/local/bin"

  PowerShell

  .\aspire-install.ps1 -InstallPath 'C:\Tools\Aspire'

• Install a specific version:

  Bash

  ./aspire-install.sh --version "13.0"

  PowerShell

  .\aspire-install.ps1 -Version '13.0'

• Install development builds:

  Bash

  ./aspire-install.sh --quality "dev"

  PowerShell

  .\aspire-install.ps1 -Quality 'dev'

• Download and install development builds in one command:

  Bash

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

  PowerShell

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

• Install with verbose output (Linux/macOS only):

  Bash

  ./aspire-install.sh --verbose

  PowerShell

  # The --verbose option is not available in the PowerShell script.

Uninstall

There’s no uninstall script. Delete the installation directory, such as %USERPROFILE%\.aspire\bin on Windows or $HOME/.aspire/bin on Linux/macOS.

To delete the installation directory, run the following command from your terminal:

Bash

rm -rf $HOME/.aspire/bin

PowerShell

Remove-Item -Recurse -Force "$HOME\.aspire\bin"

Reminder

After deleting the installation directory, don’t forget to remove it from your PATH environment variable.

See also

• Install Aspire CLI
• aspire command reference