aspire run command

Name

aspire run - Run an Aspire AppHost in development mode.

Synopsis

Aspire CLI

aspire run [options] [[--] <additional arguments>...]

Description

The aspire run command runs the AppHost project in development mode, which configures the Aspire environment, builds and starts resources defined by the AppHost, launches the web dashboard, and prints a list of endpoints.

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 performs the following steps to run an Aspire AppHost:

• Creates or modifies the .aspire/settings.json config file in the current directory, and sets the appHostPath config value to the path of the AppHost project file.
• Installs or verifies that Aspire’s local hosting certificates are installed and trusted.
• Builds the AppHost project and its resources.
• Starts the AppHost and its resources.
• Starts the dashboard.

The following snippet is an example of the output displayed by the aspire run command:

Aspire CLI

Dashboard:  https://localhost:17244/login?t=9db79f2885dae24ee06c6ef10290b8b2

    Logs:  /home/vscode/.aspire/cli/logs/apphost-5932-2025-08-25-18-37-31.log

        Press CTRL+C to stop the apphost and exit.

Options

The following options are available:

• --

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

• --detach

  Run the AppHost in the background and exit after it starts. The AppHost continues running as a background process. Use aspire ps to list running AppHosts and aspire stop to stop them.

• --format <Json|Table>

  Output result format. Only valid when used with --detach. Use Json for machine-readable output suitable for scripting and automation.

• --isolated

  Run in isolated mode with randomized ports and isolated user secrets, allowing multiple instances of the same AppHost to run simultaneously. This is useful for parallel testing or comparing different configurations side-by-side.

• --no-build

  Do not build or restore the project before running. Use this option when you have already built the project and want to skip the build step for faster startup.

• --project

  The path to the Aspire AppHost project file.

• -?, -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 Aspire CLI is doing when a command is run.

• --wait-for-debugger

  Wait for a debugger to attach before running a command.

Examples

• Search the current directory structure for AppHost projects to build and run:

  Aspire CLI

  aspire run

• Run a specific AppHost project:

  Aspire CLI

  aspire run --project './projects/apphost/orchestration.AppHost.csproj'

• Run a specific AppHost project with arguments:

  Aspire CLI

  aspire run --project './projects/apphost/orchestration.AppHost.csproj' -- -fast

• Run the AppHost in the background:

  Aspire CLI

  aspire run --detach

• Run the AppHost in the background with JSON output:

  Aspire CLI

  aspire run --detach --format Json

• Run in isolated mode for parallel testing:

  Aspire CLI

  aspire run --isolated

• Skip building and run immediately:

  Aspire CLI

  aspire run --no-build