# aspire command

## Name

`aspire` - The generic driver for the Aspire CLI.

## Synopsis

To get information about the available commands and the environment:

```bash title="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.

- <Include relativePath="reference/cli/includes/option-version.md" />

- <Include relativePath="reference/cli/includes/option-log-level.md" />

- <Include relativePath="reference/cli/includes/option-non-interactive.md" />

- <Include relativePath="reference/cli/includes/option-nologo.md" />

- <Include relativePath="reference/cli/includes/option-banner.md" />

- <Include relativePath="reference/cli/includes/option-wait.md" />

## Commands

The following commands are available:

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

## Examples

- Create an Aspire solution from the template:

  ```bash title="Aspire CLI"
  aspire new aspire-starter
  ```

- Run an Aspire AppHost:

  ```bash title="Aspire CLI"
  aspire run
  ```