aspire config set command

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

Name

aspire config set - Set a configuration value.

Synopsis

Aspire CLI

aspire config set <key> <value> [options]

Description

The aspire config set command sets 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.

Arguments

The following arguments are available:

• key

  The configuration key to set.

• value

  The configuration value to set.

Options

The following options are available:

• -g, --global

  Set the configuration value globally in $HOME/.aspire/settings.json instead of the local settings file.

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

Settings

The following config settings are available:

Setting	Description
appHostPath	The path to the AppHost project that the Aspire CLI uses by default. This setting is set by the Aspire CLI when you select a project or when Aspire is first run and detects an AppHost project.
features.deployCommandEnabled	Enables or disables the deploy command in Aspire CLI. Set to true to allow deployment features, or false to disable them.
features.execCommandEnabled	Enables or disables the exec command in Aspire CLI. Set to true to allow execution features, or false to disable them.