Aspire CLI 概述

Aspire CLI（aspire命令）是一种跨平台工具，提供命令行功能来创建、管理、运行和发布 polyglot Aspire 项目。 Aspire使用 CLI 简化开发工作流并协调分布式应用程序的服务。

Aspire CLI 是以交互为主的体验。

• Aspire安装 CLI。
• aspire 命令引用。

使用模板

命令参考： aspire new

该 aspire new 命令是交互式优先 CLI 体验，用于创建一个或多个 Aspire 项目。 在创建项目过程中， Aspire CLI 可确保将最新的 Aspire 项目模板安装到 dotnet 系统中。

使用aspire new命令从模板列表中创建一个Aspire项目。 选择模板后，将设置项目的名称，并选择输出文件夹， aspire 下载最新的模板并生成一个或多个项目。

虽然命令行参数可以用于自动创建 Aspire 项目，但是 Aspire CLI 的设计是以交互体验为优先。

Aspire启动 AppHost

命令参考： aspire run

该 aspire run 命令在开发模式下运行 AppHost 项目，该项目配置 Aspire 环境、生成和启动 AppHost 定义的资源、启动 Web 仪表板并打印终结点列表。

当 aspire run 启动时，它会在当前目录中搜索 AppHost 项目。 如果未找到项目，则将在子目录中进行搜索直到找到为止。 如果未找到 AppHost 项目， Aspire 将停止。 找到项目后， Aspire CLI 将执行以下步骤：

• 安装或验证 Aspire 的本地托管证书已安装并受信任。
• 生成 AppHost 项目及其资源。
• 启动 AppHost 及其资源。
• 启动仪表板。

以下代码片段是命令显示的 aspire run 输出示例：

Dashboard:  https://localhost:17178/login?t=17f974bf68e390b0d4548af8d7e38b65

    Logs:  /home/vscode/.aspire/cli/logs/apphost-1295-2025-07-14-18-16-13.log

添加集成

命令参考： aspire add

此命令 aspire add 是将官方集成包添加到 AppHost 项目的一种简单方法。 将此用作通过 IDE 进行 NuGet 搜索的替代方法。 如果知道集成包的名称或 NuGet ID，则可以运行 aspire add <name|id> 。 如果省略名称或 ID，该工具会提供可供选择的包列表。 如果提供部分名称或 ID，该工具会筛选包含与提供值匹配的项的包列表。

发布 Aspire 应用程序（预览版）

命令参考： aspire publish

该 aspire publish 命令通过将资源序列化到磁盘来发布。 运行此命令时， Aspire 按声明的顺序调用已注册 PublishingCallbackAnnotation 的资源批注。 这些批注序列化资源，以便部署工具可以使用它。

某些集成会自动为你注册 PublishingCallbackAnnotation ，例如：

• AzureEnvironmentResource 生成 Bicep 资产。
• DockerComposeEnvironmentResource 生成 docker-compose yaml。
• KubernetesEnvironmentResource 生成 Kubernetes Helm 图表。

部署 Aspire 应用程序（预览版）

命令参考： aspire deploy

forfiles /S 命令类似于 dir /S。 在 Aspire 调用发布注解将资源序列化到磁盘后，DeployingCallbackAnnotation 它会按照它们被声明的顺序调用资源注解。

从 Aspire 9.4 开始，Aspire 的资源不包含任何默认部署注释，必须使用 DeployingCallbackAnnotation 来构建自己的部署注释。

管理 Aspire 配置

命令参考： aspire config

使用 aspire config 此命令可以管理 Aspire CLI 配置设置。 使用它来list、get、set 或 delete 配置控制 CLI 行为的值。 此命令还用于打开或关闭功能。

有关 CLI 配置的详细信息 Aspire ，请参阅 什么是 Aspire 配置？

在资源上下文中运行命令（预览版）

命令参考： aspire exec

该 aspire exec 命令在特定资源的上下文 Aspire 中运行命令，继承该资源的配置，包括环境变量、连接字符串和工作目录。 这对于运行 Entity Framework 迁移等方案特别有用，在这些方案中，需要使用与应用程序相同的配置运行命令。 例如，可以运行 aspire exec --resource api -- dotnet ef migrations add Init 实体框架命令，并自动配置正确的数据库连接字符串。