aspire secret get command

Name

aspire secret get - Get a secret value.

Synopsis

Aspire CLI

aspire secret get <key> [options]

Description

The aspire secret get command retrieves a user secret value for an 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.

The command returns the following exit codes:

• 0—The command succeeded.
• 3—Failed to find the AppHost project.
• 4—The specified secret key was not found.

Arguments

The following arguments are available:

• key

  The secret key to retrieve.

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

• Get the value of a password parameter:

  Aspire CLI

  aspire secret get Parameters:postgres-password

• Get a secret for a specific AppHost:

  Aspire CLI

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