aspire command
This article applies to: ✔️ Aspire CLI 9.4.0 and later versions.
aspire - The generic driver for the Aspire CLI.
Synopsis
Section titled “Synopsis”To get information about the available commands and the environment:
aspire [command] [options]Description
Section titled “Description”The aspire command provides commands for working with Aspire projects. For example, aspire run runs your Aspire AppHost.
Options
Section titled “Options”The following options are available when aspire is used by itself, without specifying a command. For example, aspire --version.
-
-?, -h, --helpPrints help and usage documentation for the available commands and options.
-
--versionPrints the version of the Aspire CLI tool.
-
-d, --debugEnable debug logging to the console, which prints detailed information about what .NET Aspire CLI is doing when a command is run.
-
--wait-for-debuggerWait for a debugger to attach before running a command.
Commands
Section titled “Commands”The following commands are available:
| Command | Status | Function |
|---|---|---|
aspire add | Stable | Add an integration to the Aspire project. |
aspire config | Stable | Configures the Aspire environment. |
aspire deploy | Preview | Deploys the artifacts created by aspire publish. |
aspire exec | Preview | Similar to the aspire run command, but passes commands to the apphost. |
aspire new | Stable | Create an Aspire sample project from a template. |
aspire publish | Preview | Generates deployment artifacts for an Aspire apphost project. |
aspire run | Stable | Run an Aspire apphost for local development. |
Examples
Section titled “Examples”-
Create an Aspire solution from the template:
Aspire CLI aspire new aspire-starter -
Run an Aspire AppHost:
Aspire CLI aspire run