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. Assuming you have the prerequisites installed, you can install the Aspire CLI and create a new project.

1. Install the Aspire CLI:

   Install the Aspire CLI globally

   dotnet tool install --global aspire.cli --prerelease

   Note

   The Aspire CLI is currently in preview, hence the --prerelease flag is used.

2. Verify the installation by checking the Aspire CLI version:

   Check Aspire CLI version

   aspire --version

   You should see the version number of the Aspire CLI, which indicates that it is installed correctly.

3. To see the available commands and options, run the help command:

   Aspire CLI help command

   aspire --help

   You should see an example usage format, with a list of available options and commands, similar to the following:

   Example output from the Aspire CLI help command

   Description:
     The Aspire CLI can be used to create, run, and publish Aspire-based applications.
   
   Usage:
     aspire [command] [options]
   
   Options:
     -?, -h, --help       Show help and usage information
     --version            Show version information
     -d, --debug          Enable debug logging to the console.
     --wait-for-debugger  Wait for a debugger to attach before executing the command. [default: False]
   
   Commands:
     new <template>     Create a new Aspire sample project.
     run                Run an Aspire app host in development mode.
     add <integration>  Add an integration to the Aspire project.
     publish            Generates deployment artifacts for an Aspire app host project.