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

  The path to the Aspire AppHost project file.

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

• 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 --apphost ./src/MyApp.AppHost/MyApp.AppHost.csproj