aspire command

Name

aspire - The generic driver for the Aspire CLI.

Synopsis

To get information about the available commands and the environment:

Aspire CLI

aspire <command> [options]

Description

The aspire command provides commands for working with Aspire projects. For example, aspire run runs your Aspire AppHost.

Options

The following options are available when aspire is used by itself, without specifying a command. For example, aspire --version.

• -h, /h

  Show help and usage information.

• -v, --version

  Prints the version of the Aspire CLI tool.

• -l, --log-level <Critical|Debug|Error|Information|None|Trace|Warning>

  Set the minimum log level for console output. Use this option to increase diagnostics while troubleshooting or reduce output in scripted runs.

• --non-interactive

  Run the command in non-interactive mode, disabling all interactive prompts and spinners.

• --nologo

  Suppress the startup banner and telemetry notice.

• --banner

  Display the animated Aspire CLI welcome banner.

• --wait-for-debugger

  Wait for a debugger to attach before running a command.

Commands

The following commands are available:

Command	Status	Function
aspire add	Stable	Add a hosting integration to the apphost.
aspire init	Stable	Initialize Aspire in an existing codebase.
aspire new	Stable	Create a new app from an Aspire starter template.
aspire ps	Stable	List running apphosts.
aspire restore	Stable	Restore dependencies and generate SDK code for an apphost.
aspire run	Stable	Run an apphost interactively for development.
aspire start	Stable	Start an apphost in the background.
aspire stop	Stable	Stop a running apphost.
aspire update	Preview	Update integrations in the Aspire project.
aspire resource	Stable	Execute a command on a resource.
aspire wait	Stable	Wait for a resource to reach a target status.
aspire describe	Stable	Describe resources in a running apphost.
aspire export	Stable	Export telemetry and resource data to a zip file.
aspire logs	Stable	Display logs from resources in a running apphost.
aspire otel	Preview	View OpenTelemetry data from a running apphost.
aspire deploy	Preview	Deploy an apphost to its deployment targets.
aspire do	Preview	Execute a specific pipeline step and its dependencies.
aspire publish	Preview	Generate deployment artifacts for an apphost.
aspire agent	Stable	Manage AI agent environment configuration.
aspire cache	Stable	Manage disk cache for CLI operations.
aspire certs	Stable	Manage HTTPS development certificates.
aspire config	Stable	Manage CLI configuration including feature flags.
aspire docs	Stable	Browse and search Aspire documentation from aspire.dev.
aspire doctor	Stable	Diagnose Aspire environment issues and verify setup.
aspire mcp	Stable	Interact with MCP tools exposed by Aspire resources.
aspire secret	Stable	Manage apphost user secrets.

Examples

• Create an Aspire solution from the template:

  Aspire CLI

  aspire new aspire-starter

• Run an Aspire AppHost:

  Aspire CLI

  aspire run