aspire config command

Name

aspire config - Manage configuration settings.

Synopsis

Aspire CLI

aspire config [command] [options]

Description

The aspire config command manages the Aspire CLI config settings.

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.

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.

Commands

The following commands are available:

Command	Status	Function
aspire config list	Stable	List current configuration values, or all available feature flags with --all.
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:

Logical key	Stored in aspire.config.json as	Description
appHostPath	appHost.path	Path to the default AppHost project for the rooted configuration.
channel	channel	Default Aspire channel used by channel-aware commands such as aspire new, aspire init, and aspire update.
features.defaultWatchEnabled	features.defaultWatchEnabled	Enable or disable watch mode by default when running Aspire applications for automatic restarts on file changes.
features.execCommandEnabled	features.execCommandEnabled	Enable or disable the legacy aspire exec command for executing commands inside running resources.
features.experimentalPolyglot:go	features.experimentalPolyglot:go	Enable or disable experimental Go language support for polyglot Aspire applications.
features.experimentalPolyglot:java	features.experimentalPolyglot:java	Enable or disable experimental Java language support for polyglot Aspire applications.
features.experimentalPolyglot:python	features.experimentalPolyglot:python	Enable or disable experimental Python language support for polyglot Aspire applications.
features.experimentalPolyglot:rust	features.experimentalPolyglot:rust	Enable or disable experimental Rust language support for polyglot Aspire applications.
features.showAllTemplates	features.showAllTemplates	Show all available templates, including experimental ones, in aspire new and aspire init.
features.showDeprecatedPackages	features.showDeprecatedPackages	Show or hide deprecated packages in aspire add search results.
features.updateNotificationsEnabled	features.updateNotificationsEnabled	Enable or disable Aspire CLI update notifications.