aspire config get command

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

Name

aspire config get - Get a configuration value.

Synopsis

Aspire CLI

aspire config get <key> [options]

Description

The aspire config get command retrieves a config value by key name.

Aspire supports a local and global settings file. Settings defined in a local settings file override those set in the global settings file.

• Local settings

  A local settings file is stored at .aspire/settings.json under the current directory.

• Global settings

  The global settings file is stored at $HOME/.aspire/settings.json.

If the config value doesn’t exist in a local settings file, the config file is retrieved from the global settings file.

The command returns the following exit codes:

• 0—The command succeeded.
• 10—The supplied key doesn’t exist in the config file, or the config file is missing.

Arguments

The following arguments are available:

• key

  The configuration key to retrieve.

Options

The following options are available:

• -?, -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 .NET Aspire CLI is doing when a command is run.

• --wait-for-debugger

  Wait for a debugger to attach before running a command.