Edit

Share via

aspire config get command

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

Name

aspire config get - Get a configuration value.

Synopsis

aspire config get <key> [options]

Description

The aspire config get command retrieves 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/globalsettings.json.

If the config value doesn't exist in a local settings file, the config file is retrieved from the global settings file.

The command returns the following exit codes:

  • 0—The command succeeded.
  • 10—The supplied key doesn't exist in the config file, or the config file is missing.

Arguments

The following arguments are available:

  • key

    The configuration key to retrieve.

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 Aspire CLI is doing when a command is run.

  • --wait-for-debugger

    Wait for a debugger to attach before running a command.

Available 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.execCommandEnabled Enables or disables the exec command in Aspire CLI. Set to true to allow execution features, or false to disable them.
features.minimumSdkCheckEnabled Enables or disables minimum SDK version checking in Aspire CLI. Set to true to enforce SDK version requirements, or false to disable the check.
features.orphanDetectionWithTimestampEnabled Enables or disables orphan resource detection with timestamp tracking in Aspire CLI. Set to true to enable enhanced orphan detection, or false to disable it.
features.packageSearchDiskCachingEnabled Enables or disables disk caching for package search results in Aspire CLI. Set to true to cache search results locally, or false to disable caching.
features.showDeprecatedPackages Controls whether deprecated packages are shown in search results and package listings. Set to true to show deprecated packages, or false to hide them.
features.singleFileAppHostEnabled Enables or disables support for single-file AppHost projects in Aspire CLI. Set to true to enable single-file AppHost support, or false to disable it.
features.stagingChannelEnabled Enables or disables access to staging channel packages and features in Aspire CLI. Set to true to enable staging channel access, or false to disable it.
features.updateNotificationsEnabled Enables or disables update notifications in Aspire CLI. Set to true to show notifications about available updates, or false to disable them.