aspire secret set command

Name

aspire secret set - Set a secret value.

Synopsis

Aspire CLI

aspire secret set <key> <value> [options]

Description

The aspire secret set command sets a user secret value for an Aspire AppHost. If user secrets haven’t been initialized for the AppHost yet, this command automatically initializes them before setting the value.

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:

• key

  The secret key to set. Use a colon (:) as a separator for hierarchical keys, such as Parameters:postgres-password.

• value

  The secret value to set.

Options

The following options are available:

• --apphost

  The path to the Aspire AppHost project file. Alias: --project.

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

• Set a password parameter:

  Aspire CLI

  aspire secret set Parameters:postgres-password MySecretPassword123

• Set a secret for a specific AppHost:

  Aspire CLI

  aspire secret set Parameters:rabbitmq-password Pass123 --project ./src/MyApp.AppHost/MyApp.AppHost.csproj