Configuration settings

Aspire configuration is a rooted aspire.config.json file for project-scoped CLI configuration. Use the aspire config command family to inspect and update those settings, and use aspire config list --all to see the feature flags surfaced by your installed CLI.

Configuration file model

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.

The consolidated aspire.config.json file can also contain other rooted Aspire configuration such as SDK version, launch profiles, and package pins. This page focuses on the settings surfaced through aspire config.

Example aspire.config.json

aspire.config.json

{
  "appHost": {
    "path": "./src/MyApp.AppHost/MyApp.AppHost.csproj"
  },
  "channel": "staging",
  "features": {
    "defaultWatchEnabled": true,
    "showAllTemplates": true,
    "updateNotificationsEnabled": true
  }
}

Settings surfaced by aspire config

Use aspire config list to see the values that are currently set, and use aspire config list --all to enumerate the feature flags your installed CLI can configure.

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.

Tip

Some feature flags shown by aspire config list --all may correspond to preview, migration, or hidden functionality. Treat the output of your installed CLI as the authoritative source for what can be configured.

Working with configuration

• Use aspire config list to show currently set project-scoped and global values.

• Use aspire config list --all to include the feature flags that your installed CLI can configure.

• Use aspire config get <key> to inspect a specific setting such as channel or appHostPath.

• Use aspire config set <key> <value> to update a setting, and aspire config set --global ... when you want a user-scoped default.

CLI commands

Command	Status	Function
aspire config	Stable	Command driver for managing Aspire configuration.
aspire config list	Stable	List currently configured 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.

For command-level details, see the aspire config command reference.