Edit

Share via

aspire run command

This article applies to: ✔️ Aspire CLI 9.4.0 and later versions.

Name

aspire run - Run an Aspire AppHost in development mode.

Synopsis

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:

Dashboard:  https://localhost:17178/login?t=17f974bf68e390b0d4548af8d7e38b65

    Logs:  /home/vscode/.aspire/cli/logs/apphost-1295-2025-07-14-18-16-13.log

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.

  • --project

    The path to the Aspire AppHost project file.

  • -w, --watch

    Start project resources in watch mode.

  • -?, -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 run

  • Run a specific AppHost project:

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

  • Run a specific AppHost project with arguments:

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