aspire config get command

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.

Starting in Aspire 13.2, Aspire prefers a rooted aspire.config.json file for project-scoped configuration. The CLI can also read and write user-scoped global defaults.

• Project-scoped configuration

  Project-scoped settings live in a rooted aspire.config.json file. This replaces the older .aspire/settings.json model.

• Global configuration

  User-scoped defaults can be set with aspire config set --global .... Project-scoped settings override global values when both are present.

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.

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