Aspire CLI (aspirecommand) 是一種跨平臺工具,提供命令行功能來建立、管理、執行及發佈 polyglot Aspire 專案。
Aspire使用 CLI 簡化開發工作流程,並協調分散式應用程式的服務。
Aspire CLI 是以互動性優先的體驗。
Tip
如需逐步教學課程以使用命令aspire deploy,請參閱使用Aspire CLI 將Azure Container Apps專案部署至Aspire。
使用範本
aspire new此命令是互動式優先 CLI 體驗,可用來建立一或多個Aspire專案。 在建立專案時, Aspire CLI 可確保最新的 Aspire 專案範本會安裝到 dotnet 系統中。
使用aspire new 命令從範本清單建立Aspire專案。 選取範本之後,就會設定項目的名稱,並選擇輸出資料夾, aspire 下載最新的範本併產生一或多個專案。
雖然命令列參數可用來自動建立 Aspire 專案,但是 Aspire CLI 提供的是以互動為優先的體驗。
Aspire 啟動 AppHost
此 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 是將官方整合套件新增至AppHost項目的簡單方式。 使用此選項作為透過 IDE 進行 NuGet 搜尋的替代方案。 如果您知道整合套件的名稱或 NuGet 識別碼, 則可以執行 aspire add <name|id> 。 如果您省略名稱或識別碼,此工具會提供可供選擇的套件清單。 如果您提供部分名稱或ID,此工具會篩選出與所提供值匹配的套件清單。
發佈 Aspire 應用程式 (預覽)
命令 aspire publish 會透過將資源序列化至硬碟來發佈資源。 執行此命令時, Aspire 會依宣告資源批註的順序叫用已註冊 PublishingCallbackAnnotation 的資源批註。 這些批注會將資源序列化,以便部署工具使用。
某些集成會自動為您註冊 PublishingCallbackAnnotation,例如:
- AzureEnvironmentResource 會產生 Bicep 資產。
- DockerComposeEnvironmentResource 生成 docker-compose yaml。
- KubernetesEnvironmentResource 會產生 Kubernetes Helm 圖表。
部署 Aspire 應用程式 (預覽)
aspire deploy 命令類似於 aspire publish。 在Aspire調用批註將資源序列化到磁碟後,它會按照聲明的順序調用DeployingCallbackAnnotation資源註解。
自 Aspire 9.4 起, Aspire 不包含其資源的任何預設部署批注,您必須使用 DeployingCallbackAnnotation 來建置自己的 。
Tip
可以視為一種將您的Aspire方案部署到預備或測試環境的良好方式。
管理 Aspire 組態
aspire config命令可讓您管理 Aspire CLI 組態設定。 將它用於組態值的list、get、set或delete 以控制 CLI 行為。 此命令也可用來開啟或關閉功能。
如需有關 Aspire CLI 組態的詳細資訊,請參閱Aspire 組態說明。
在資源環境中執行命令(預覽)
此命令 aspire exec 會在特定 Aspire 資源的內容中執行命令,並繼承該資源的組態,包括環境變數、連接字串和工作目錄。 這對於執行 Entity Framework 移轉之類的案例特別有用,因為您需要執行與應用程式相同組態的命令。 例如,您可以執行 aspire exec --resource api -- dotnet ef migrations add Init 以自動設定適當的資料庫連接字串來執行 Entity Framework 命令。
這很重要
🧪 功能旗標: aspire exec 此命令位於功能旗標後方,在此版本中 預設為停用 。 它必須明確啟用,才能搭配 aspire config set features.execCommandEnabled true使用。