aspire config command

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

Name

aspire config - Manage configuration settings.

aspire config [command] [options]

The aspire config command manages the Aspire CLI config settings.

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.

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.

The following commands are available:

Command	Status	Function
`aspire config list`	Stable	List all configuration values.
`aspire config get <key>`	Stable	Get a configuration value.
`aspire config set <key> <value>`	Stable	Set a configuration value.
`aspire config delete <key>`	Stable	Delete a configuration value.

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.