通过

什么是 Aspire CLI 配置？

Aspire CLI 使用配置文件来控制其行为。 可以配置功能标志来启用或禁用 CLI 功能，并指定 CLI 默认应用于 Aspire 解决方案的 AppHost 项目。

设置文件存储在文件夹中 .aspire ，并命名 settings.json。 设置文件可以存储在本地或全局。

以下代码片段是一个示例 .aspire/settings.json 文件：

{
  "appHostPath": "../AspireShop/AspireShop.AppHost/AspireShop.AppHost.csproj",
  "features": {
    "deployCommandEnabled": "true"
  }
}

配置文件位置

全局 Aspire CLI 设置文件存储在 CLI 中 $HOME/.aspire/globalsettings.json，并用作 CLI 的默认设置。 本地设置文件覆盖全局文件中的设置。 本地设置文件存储在 ./.aspire/settings.json.

生成配置文件

当你运行需要与 AppHost 交互的命令或设置配置选项时，CLI 会自动生成本地设置文件。 例如，aspire run 会搜索一个 AppHost 项目，并在找到时生成一个文件，其中 ./.aspire/settings.json 设置为该项目。

重要

appHostPath 可以全局设置，但 CLI 将忽略它，并且仅在本地设置文件中读取它。

设置

Aspire CLI 支持两类配置设置：

  • 功能标志
    这些设置启用或禁用特定的 CLI 功能。 所有功能标志设置名称都以 feature. 开头。

  • CLI 行为
    这些设置控制 CLI 的运行方式。 目前，唯一的 CLI 行为设置是 appHostPath指定 AppHost 项目的位置。

下表列出了可在配置文件中设置的设置：

设置 Description
appHostPath CLI 默认使用的 AppHost 项目的路径是 Aspire。 在你选择项目或Aspire首次运行并检测到 AppHost 项目时，CLI 会设置此设置。
features.execCommandEnabled exec启用或禁用 CLI 中的Aspire命令。 true设置为允许执行功能，或false禁用它们。
features.minimumSdkCheckEnabled 启用或禁用 CLI 中的 Aspire 最低 SDK 版本检查。 设置为 true 强制实施 SDK 版本要求，或 false 禁用检查。
features.orphanDetectionWithTimestampEnabled 在 CLI 中使用 Aspire 时间戳跟踪启用或禁用孤立资源检测。 将true设置为启用增强的孤立检测，或将false设置为禁用。
features.packageSearchDiskCachingEnabled 在 CLI 中 Aspire 启用或禁用包搜索结果的磁盘缓存。 设置为 true 在本地缓存搜索结果，或 false 禁用缓存。
features.showDeprecatedPackages 控制已弃用的包是否显示在搜索结果和包列表中。 设置为 true 显示已弃用的包，或 false 隐藏它们。
features.singleFileAppHostEnabled 启用或禁用对 CLI 中的 Aspire 单文件 AppHost 项目的支持。 设置为 true 启用单文件 AppHost 支持，或 false 将其禁用。
features.stagingChannelEnabled 启用或禁用对 CLI 中的 Aspire 过渡通道包和功能的访问。 设置true以启用暂存通道访问，或设置false以禁用暂存通道访问。
features.updateNotificationsEnabled 在 CLI 中 Aspire 启用或禁用更新通知。 true设置为显示有关可用更新的通知，或false禁用它们。

CLI 命令

Command 状态 功能
aspire config 稳定 用于管理 Aspire 配置的命令驱动程序。
aspire config list 稳定 列出所有配置值。
aspire config get <key> 稳定 获取配置值。
aspire config set <key> <value> 稳定 设置配置值。
aspire config delete <key> 稳定 删除配置值。