aspire add command

Name

aspire add - Add an integration to the Aspire project.

aspire add [<integration>] [options]

The aspire add command searches for an integration package and adds it to the Aspire AppHost.

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.

The following arguments are available:

integration

The name of the integration to add (for example: redis, postgres).

If a partial name or invalid name is provided, the CLI searches NuGet for approximate matches and prints them in the terminal for the user to select. If no results are found, all packages are listed.

The following options are available:

--apphost <apphost>

The path to the Aspire AppHost project file.
-v, --version

The version of the integration to add.
-s, --source

The NuGet source to use for the integration.
-?, -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.

Finds an AppHost project and lists all Aspire integration packages from NuGet:
Aspire CLI
```
aspire add
```
Finds an AppHost project and adds the kafka (Aspire.Hosting.Kafka) integration package:
Aspire CLI
```
aspire add kafka --version 13.2.0
```