aspire config command

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

Name

aspire config - Manage configuration settings.

Synopsis

Aspire CLI

aspire config [command] [options]

Description

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.

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.

Commands

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.

Settings

The following config settings are available:

Setting	Description
appHostPath	Path to default AppHost project.
features.execCommandEnabled	Enable exec command.
features.minimumSdkCheckEnabled	Enforce minimum SDK version.
features.orphanDetectionWithTimestampEnabled	Use timestamp-based orphan detection.
features.packageSearchDiskCachingEnabled	Cache package search results on disk.
features.showDeprecatedPackages	Show deprecated packages.
features.singleFileAppHostEnabled	Support single-file AppHost projects.
features.stagingChannelEnabled	Use staging channel packages.
features.updateNotificationsEnabled	Show update notifications.