aspire do command

Name

aspire do - Execute a specific pipeline step and its dependencies.

Synopsis

Aspire CLI

aspire do <step> [options] [[--] <additional arguments>...]

Description

The aspire do command executes a specific pipeline step and its dependencies in your Aspire AppHost. This command provides fine-grained control over the orchestration pipeline, allowing you to run individual steps of the deployment or build process.

The Aspire CLI uses the following logic, in order, to determine which AppHost project to process:

• The --project option.

  This option specifies the path to a project to process.

• The .aspire/settings.json config file.

  If the config file path exists in the current directory, it’s used. If not, the CLI walks up the directory structure looking for the config file. If it finds a config file, it reads the appHostPath setting value as the project to process.

• Searches the current directory and subdirectories.

  Starting in the current directory, the CLI gathers all AppHost projects from that directory and below. If a single project is discovered, it’s automatically selected. If multiple projects are discovered, they’re printed to the terminal for the user to manually select one of the projects.

  Once a project is selected, either automatically or manually, the path to the project is stored in the .aspire/settings.json config file.

The command allows you to:

• Execute specific pipeline steps without running the entire pipeline
• Run only the dependencies needed for a particular step
• Test individual pipeline stages during development
• Customize pipeline execution with environment-specific settings

Arguments

The following arguments are available:

• step

  The name of the step to execute.

Options

The following options are available:

• --

  Delimits arguments to aspire do from arguments for the AppHost. All arguments after this delimiter are passed to the application being run.

• --project

  The path to the Aspire AppHost project file.

• -o, --output-path

  The optional output path for artifacts.

• --log-level

  Set the minimum log level for pipeline logging. Valid values are: trace, debug, information, warning, error, critical. The default is information.

• -e, --environment

  The environment to use for the operation. The default is Production.

• -?, -h, --help

  Prints help and usage documentation for the available commands and options.

• -d, --debug

  Enable debug logging to the console, which prints detailed information about what .NET Aspire CLI is doing when a command is run.

• --wait-for-debugger

  Wait for a debugger to attach before running a command.

Examples

• Execute a specific pipeline step:

  Aspire CLI

  aspire do build

• Execute a pipeline step with debug logging:

  Aspire CLI

  aspire do deploy --log-level debug

• Execute a pipeline step for a specific environment:

  Aspire CLI

  aspire do publish --environment Staging

• Execute a pipeline step with custom output path:

  Aspire CLI

  aspire do build --output-path ./artifacts

• Execute a pipeline step with additional arguments:

  Aspire CLI

  aspire do test -- --configuration Release