aspire secret list command

Name

aspire secret list - List all secrets.

Synopsis

Aspire CLI

aspire secret list [options]

Description

The aspire secret list command lists all user secrets stored for an Aspire AppHost. By default, secrets are displayed in a table format sorted alphabetically by key. If no secrets are configured, the command displays “No secrets configured.”

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.

Options

The following options are available:

• --format <Json|Table>

  Output format. Use Json for machine-readable output suitable for scripting and automation. Defaults to Table.

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

• List all secrets for the current AppHost:

  Aspire CLI

  aspire secret list

• List secrets in JSON format:

  Aspire CLI

  aspire secret list --format json

• List secrets for a specific AppHost:

  Aspire CLI

  aspire secret list --project ./src/MyApp.AppHost/MyApp.AppHost.csproj