aspire start command

Ce contenu n’est pas encore disponible dans votre langue.

Name

aspire start - Start an apphost in the background.

Synopsis

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

Description

The aspire start command starts an AppHost in the background and exits after the apphost is running. Use it when you want a detached apphost that you can inspect later with commands such as aspire ps, aspire describe, aspire logs, and aspire stop.

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

The --apphost option.

This option specifies the path to the Aspire AppHost project file to process.
The rooted aspire.config.json file.

If the rooted config exists in the current directory, it’s used. If not, the CLI walks up the directory structure looking for it. If Aspire finds the rooted config, it uses the recorded AppHost information to determine which project to process. Legacy .aspire/settings.json files are still read during migration.
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, Aspire records that selection in the rooted configuration so later commands can reuse it.

You can output detached startup details as a table or JSON, and you can pass additional arguments through to the AppHost by using the -- delimiter.

Hot Reload and watch behavior

By default, aspire start starts the AppHost as a detached background process. It doesn’t watch the AppHost or resource source files. After you change AppHost code, restart the detached AppHost by running aspire start again. For individual resource changes, keep the AppHost running and restart or rebuild the resource from the Aspire CLI or dashboard when needed.

Aspire also has an opt-in defaultWatchEnabled feature flag. When enabled, Aspire uses watch mode by default and automatically restarts the Aspire application after file changes:

aspire config set features.defaultWatchEnabled true

Use Aspire watch mode when you want Aspire to restart the AppHost-managed application for you after AppHost changes. It supports both C# and TypeScript AppHosts; C# project resources are also controlled by this setting today. Other resource hot reload behavior depends on the framework or runtime backing the resource. For more information, see Hot Reload and watch.

Options

The following options are available:

--

Delimits arguments to aspire start from arguments for the AppHost being run. All arguments after this delimiter are passed to the application.
--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 restore and build step.
--apphost <apphost>

The path to the Aspire AppHost project file.
--format <Json|Table>

Output format for detached apphost results. 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.
-?, -h, --help

Prints help and usage documentation for the available commands and options.
-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.

Examples

Start the AppHost discovered from the current directory:
Aspire CLI
```
aspire start
```

Start a specific AppHost in the background:

aspire start --apphost './src/MyApp.AppHost/MyApp.AppHost.csproj'

Output detached startup details as JSON:
Aspire CLI
```
aspire start --format Json
```
Start the AppHost in isolated mode:
Aspire CLI
```
aspire start --isolated
```
Start the AppHost with a specific environment:
Aspire CLI
```
aspire start --environment Development
```