Edit

Share via

aspire add command

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

Name

aspire add - Add an integration to the Aspire project.

Synopsis

aspire add [<integration>] [options]

Description

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 --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.

Arguments

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.

Options

The following options are available:

  • --project

    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.

  • -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

  • Finds an AppHost project and lists all Aspire integration packages from NuGet:

    aspire add

  • Finds an AppHost project and adds the kafka (Aspire.Hosting.Kafka) integration package:

    aspire add kafka --version 9.3.2