diff --git a/src/frontend/src/content/docs/get-started/ai-coding-agents.mdx b/src/frontend/src/content/docs/get-started/ai-coding-agents.mdx index 5ba069d0f..cdf5d8841 100644 --- a/src/frontend/src/content/docs/get-started/ai-coding-agents.mdx +++ b/src/frontend/src/content/docs/get-started/ai-coding-agents.mdx @@ -21,7 +21,7 @@ Aspire gives coding agents the same visibility into your running application tha The Aspire CLI is built for agent-driven workflows — commands support non-interactive execution to avoid blocking on prompts, and many commands support `--format Json` for structured plain text output. Key commands include `aspire start` (background execution), `aspire start --isolated` (parallel worktrees), `aspire wait` (block until healthy), `aspire describe`, `aspire logs`, and `aspire docs search`. -The Aspire skill file (installed by `aspire agent init`) teaches agents all of these patterns automatically. +Aspire workflow skills installed by `aspire agent init` teach agents these patterns automatically. ## Get started @@ -46,10 +46,19 @@ When you create a new Aspire project with `aspire new` or `aspire init`, you're | **GitHub Skills** | `.github/skills/` | VS Code / GitHub Copilot specific | | **OpenCode** | `.opencode/skill/` | OpenCode specific | -1. Select the **skills and tools** to install into those locations. All options are pre-selected by default: - - **Aspire skill** — teaches your AI agent how to use Aspire CLI commands - - **Playwright CLI** — enables browser automation for testing web resources - - **dotnet-inspect skill** — teaches your AI agent to query .NET API surfaces +1. Select the **skills and tools** to install into those locations. The Aspire workflow skills from [`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills) are: + - **aspire** — routes Aspire tasks to the right workflow + - **aspire-init** — creates a new Aspire app or adds an Aspire skeleton to an existing repo + - **aspire-orchestration** — starts, stops, waits for, and manages Aspire resources + - **aspire-monitoring** — inspects logs, traces, metrics, resource state, and diagnostics data + - **aspire-deployment** — publishes, deploys, and tears down Aspire apps + - **aspireify** — wires an AppHost after `aspire init` + + The flow pre-selects the workflow skills that apply to the command you're running. Add Playwright CLI for browser checks, dotnet-inspect for .NET API surface queries, or select **Install Aspire MCP server** if the agent needs live data from a running Aspire app. + + :::note[Aspire workflow skills bundle] + Aspire workflow skills are distributed through the [`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills) GitHub release assets. Aspire 13.4 includes an embedded snapshot for default installs, and the optional remote fetch path can download matching release assets. Companion options such as Playwright CLI and dotnet-inspect are installed separately when selected. + ::: @@ -57,33 +66,41 @@ When you create a new Aspire project with `aspire new` or `aspire init`, you're The `aspire agent init` command detects your AI development environment and creates the appropriate configuration files: -### Aspire skill file +### Aspire workflow skill files + +Aspire workflow skills teach your AI coding agent how to work with Aspire. The top-level `aspire` skill routes requests to focused skills for initialization, orchestration, monitoring, deployment, and AppHost wiring. -The skill file teaches your AI coding agent how to work with Aspire. It includes a CLI command reference, key workflows (starting apps, debugging issues, adding integrations), and important rules to follow. The file is installed into each selected skill location: +For example, a standard location can contain: -- .agents/skills/aspire/ - - SKILL.md Standard (VS Code, GitHub Copilot, OpenCode) -- .github/skills/aspire/ - - SKILL.md GitHub Copilot (legacy location) -- .claude/skills/aspire/ - - SKILL.md Claude Code -- .opencode/skill/aspire/ - - SKILL.md OpenCode +- .agents/skills/ + - aspire/ + - SKILL.md + - aspire-init/ + - SKILL.md + - aspire-orchestration/ + - SKILL.md + - aspire-monitoring/ + - SKILL.md + - aspire-deployment/ + - SKILL.md + - aspireify/ + - SKILL.md -The skill file guides your agent on how to: +The skills guide your agent on how to: - Start and manage your Aspire application (`aspire start`, `aspire stop`, `aspire describe`) - Debug issues using structured logs and distributed traces - Add integrations with `aspire add` and search documentation with `aspire docs` - Use resource MCP tools for database queries and other resource-specific operations +- Route first-run setup, AppHost wiring, monitoring, orchestration, and deployment work to focused workflows ### dotnet-inspect skill -The `dotnet-inspect` skill teaches your AI agent to query .NET API surfaces using the [`dotnet-inspect`](https://github.com/richlander/dotnet-inspect) tool. It's installed alongside the Aspire skill in each selected location: +The `dotnet-inspect` companion skill teaches your AI agent to query .NET API surfaces using the [`dotnet-inspect`](https://github.com/richlander/dotnet-inspect) tool. When selected, it's installed into each selected location: @@ -100,8 +117,8 @@ The `dotnet-inspect` skill teaches your AI agent to query .NET API surfaces usin The skill enables your agent to inspect NuGet package API surfaces, compare API changes between package versions, and explore .NET types and members. -:::note[Skill conflict] -The `dotnet-inspect` skill should not be installed alongside the Aspire skill. The Aspire skill already includes support for `aspire docs api` subcommands, providing a powerful way to query Aspire APIs across both C# and TypeScript. +:::note[When to use dotnet-inspect] +Install `dotnet-inspect` when an agent needs broad .NET API surface queries. For Aspire-specific API docs, the Aspire skills guide agents to use `aspire docs api` commands across both C# and TypeScript. ::: ### Aspire MCP server @@ -110,22 +127,22 @@ The MCP server gives your AI agent direct runtime access to your running Aspire ## Migrate from AGENTS.md -If your project has an `AGENTS.md` file from a previous version of Aspire, you can migrate to the new skill file format. The skill file provides better structure and is recognized natively by AI coding agents. +If your project has an `AGENTS.md` file from a previous version of Aspire, you can migrate to the new skill file format. Skill files provide better structure and are recognized natively by AI coding agents. -1. Run `aspire agent init` and select **Install Aspire skill file**. +1. Run `aspire agent init` and select the Aspire workflow skills you want to install. -2. The skill files are created at `.github/skills/aspire/SKILL.md` and `.claude/skills/aspire/SKILL.md`. +2. The skill files are created under each selected skill location, such as `.agents/skills/aspire/SKILL.md` and `.agents/skills/aspire-orchestration/SKILL.md`. -3. Review and delete the old `AGENTS.md` file — the skill file replaces it. +3. Review and delete the old `AGENTS.md` file — the skill files replace it. ## Your first prompts diff --git a/src/frontend/src/content/docs/get-started/aspire-skills.mdx b/src/frontend/src/content/docs/get-started/aspire-skills.mdx index 562e4fba3..fe7732681 100644 --- a/src/frontend/src/content/docs/get-started/aspire-skills.mdx +++ b/src/frontend/src/content/docs/get-started/aspire-skills.mdx @@ -9,7 +9,7 @@ import LearnMore from '@components/LearnMore.astro'; Aspire skills are Markdown instruction bundles for AI coding agents. Each skill lives in a folder with a `SKILL.md` file that describes when the skill applies and what workflow the agent should follow. Skills don't run services or expose application data; they teach the agent how to use Aspire tools correctly. -Aspire ships multiple skills for different parts of the app lifecycle. The exact list can vary by Aspire CLI version and project type, but Aspire skills are organized around workflows such as initialization, orchestration, monitoring, deployment, and AppHost wiring. +Aspire ships multiple skills for different parts of the app lifecycle. The exact list can vary by Aspire CLI version and project type, but the [`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills) bundle includes six workflow skills: `aspire`, `aspire-init`, `aspire-orchestration`, `aspire-monitoring`, `aspire-deployment`, and `aspireify`. To configure AI coding agents end to end, see [Use AI coding @@ -35,13 +35,13 @@ aspire init aspire agent init ``` -For non-interactive setup, pass the skill and location options explicitly. To install the available skills into all supported locations, use `all`: +For non-interactive setup, pass the skill and location options explicitly. To install all available skills and companion options into all supported locations, use `all`: ```bash title="Aspire CLI" aspire agent init --skills all --skill-locations all ``` -To install a subset, pass a comma-separated list of skill names: +To install a subset, pass a comma-separated list of skill names. This example installs every Aspire workflow skill from the bundle and the optional Playwright CLI companion skill: ```bash title="Aspire CLI" aspire agent init --skills aspire,aspire-init,aspire-orchestration,aspire-monitoring,aspire-deployment,aspireify,playwright-cli --skill-locations all @@ -117,7 +117,7 @@ In that command, `-a github-copilot` selects the target agent, `-g` installs glo -## Available skills +## Aspire workflow skills | Skill | Use it for | What it teaches | | ---------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -127,9 +127,19 @@ In that command, `-a github-copilot` selects the target agent, `-g` installs glo | `aspire-monitoring` | Observing running Aspire apps | Inspect resource state, logs, traces, metrics, browser telemetry, and dashboard data before making changes | | `aspire-deployment` | Publishing, deploying, and tearing down Aspire apps | Use AppHost-modeled deployments for targets such as Docker Compose, Kubernetes, Azure, and AWS | | `aspireify` | Completing Aspire initialization in an existing codebase after `aspire init` drops an AppHost skeleton | Scan the repo, propose a resource graph, wire projects and containers into the AppHost, connect resources, configure telemetry when appropriate, and validate the wiring | -| `playwright-cli` | Testing running web resources in a browser | Use Playwright CLI for browser automation, including navigation, form interaction, screenshots, and visual checks | -Use the top-level `aspire` skill when the request is about an Aspire app and the right workflow isn't obvious. Use a workflow-specific skill directly when the task is clear, such as `aspire-orchestration` for local lifecycle work, `aspire-monitoring` for telemetry investigation, `aspire-deployment` for publish and deploy workflows, or `aspireify` for existing-codebase AppHost wiring. Use `playwright-cli` when an agent needs to test or inspect a running frontend. +Use the top-level `aspire` skill when the request is about an Aspire app and the right workflow isn't obvious. Use a workflow-specific skill directly when the task is clear, such as `aspire-orchestration` for local lifecycle work, `aspire-monitoring` for telemetry investigation, `aspire-deployment` for publish and deploy workflows, or `aspireify` for existing-codebase AppHost wiring. + +## Companion skills and tools + +Companion options can be offered by `aspire agent init`, but they aren't part of the `microsoft/aspire-skills` workflow bundle. + +| Skill | Use it for | What it teaches | +| ---------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | +| `playwright-cli` | Testing running web resources in a browser | Use Playwright CLI for browser automation, including navigation, form interaction, screenshots, and visual checks | +| `dotnet-inspect` | Querying .NET API surfaces | Inspect available .NET APIs when the workspace contains a .NET AppHost | + +Use `playwright-cli` when an agent needs to test or inspect a running frontend. Use `dotnet-inspect` when an agent needs API-surface details for .NET AppHost work. ## Playwright handoff @@ -137,7 +147,7 @@ The `playwright-cli` skill works best alongside the `aspire` skill. The agent wi ## Skill locations -Aspire installs each selected skill into the selected skill locations. For example, a standard location can contain: +Aspire installs each selected skill into the selected skill locations. For example, a standard location can contain every Aspire workflow skill and selected companion skills: @@ -156,6 +166,8 @@ Aspire installs each selected skill into the selected skill locations. For examp - SKILL.md - playwright-cli/ - SKILL.md + - dotnet-inspect/ + - SKILL.md @@ -168,6 +180,22 @@ Other supported locations use the same skill folder names: | **GitHub Skills** | `.github/skills/` | VS Code / GitHub Copilot specific | | **OpenCode** | `.opencode/skill/` | OpenCode specific | +## Troubleshoot skill bundle errors + +When `aspire agent init` installs Aspire workflow skills, it validates the Aspire skills bundle before copying files. If the embedded bundle that ships with the CLI is corrupted or inconsistent, you might see errors such as: + +- `Embedded Aspire skills bundle metadata is invalid: ` +- `Embedded Aspire skills metadata must specify a version.` +- `Embedded Aspire skills archive failed SHA-256 verification. Expected '', got ''.` + +These errors indicate a problem with the Aspire CLI installation itself, not your project configuration. To resolve the issue, update the CLI: + +```bash title="Aspire CLI" +aspire update --self +``` + +The update replaces the embedded bundle. If your installation method doesn't support self-updating, follow the [Install the Aspire CLI](/get-started/install-cli/) instructions to reinstall or update the CLI. If the problem persists after updating or reinstalling, [open an issue on GitHub](https://github.com/microsoft/aspire/issues). + ## See also - [Use AI coding agents](/get-started/ai-coding-agents/) — set up your project for AI agents diff --git a/src/frontend/src/content/docs/ja/get-started/ai-coding-agents.mdx b/src/frontend/src/content/docs/ja/get-started/ai-coding-agents.mdx index 06c8624f8..bbba8b963 100644 --- a/src/frontend/src/content/docs/ja/get-started/ai-coding-agents.mdx +++ b/src/frontend/src/content/docs/ja/get-started/ai-coding-agents.mdx @@ -23,7 +23,7 @@ Aspire は、コーディングエージェントに対して、開発者が持 Aspire CLI はエージェント主導のワークフロー向けに設計されています。コマンドはプロンプト待ちでブロックしないように非対話実行をサポートし、多くのコマンドで構造化されたプレーンテキスト出力向けに `--format Json` を利用できます。主なコマンドは `aspire start`（バックグラウンド実行）、`aspire start --isolated`（並列ワークツリー）、`aspire wait`（正常状態になるまで待機）、`aspire describe`、`aspire logs`、`aspire docs search` です。 -`aspire agent init` でインストールされる Aspire スキルファイルは、これらのパターンをエージェントに自動で教えます。 +`aspire agent init` でインストールされる Aspire ワークフロースキルは、これらのパターンをエージェントに自動で教えます。 ## はじめに @@ -48,10 +48,19 @@ Aspire CLI はエージェント主導のワークフロー向けに設計され | **GitHub Skills** | `.github/skills/` | VS Code / GitHub Copilot 向け | | **OpenCode** | `.opencode/skill/` | OpenCode 専用 | -1. それらの配置先にインストールする **スキルとツール** を選択します。すべてのオプションは既定で事前選択されています: - - **Aspire skill** — AI エージェントに Aspire CLI コマンドの使い方を教えます - - **Playwright CLI** — Web リソースをテストするためのブラウザー自動化を有効にします - - **dotnet-inspect skill** — AI エージェントに .NET API サーフェスのクエリ方法を教えます +1. それらの配置先にインストールする **スキルとツール** を選択します。[`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills) の Aspire ワークフロースキルは次のとおりです: + - **aspire** — Aspire タスクを適切なワークフローにルーティングします + - **aspire-init** — 新しい Aspire アプリを作成するか、既存のリポジトリに Aspire のひな形を追加します + - **aspire-orchestration** — Aspire リソースを開始、停止、待機、管理します + - **aspire-monitoring** — ログ、トレース、メトリック、リソース状態、診断データを確認します + - **aspire-deployment** — Aspire アプリを発行、デプロイ、削除します + - **aspireify** — `aspire init` の後に AppHost を配線します + + フローでは、実行しているコマンドに適したワークフロースキルが事前選択されます。ブラウザー確認には Playwright CLI、.NET API サーフェスのクエリには dotnet-inspect を追加します。実行中の Aspire アプリからのライブデータが必要な場合は、**Install Aspire MCP server** を選択します。 + + :::note[Aspire ワークフロースキルバンドル] + Aspire ワークフロースキルは、[`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills) GitHub リリースアセットを通じて配布されます。Aspire 13.4 には既定インストール向けの埋め込みスナップショットが含まれ、任意のリモート取得パスでは一致するリリースアセットをダウンロードできます。Playwright CLI や dotnet-inspect などのコンパニオンオプションは、選択した場合に個別にインストールされます。 + ::: @@ -59,33 +68,41 @@ Aspire CLI はエージェント主導のワークフロー向けに設計され `aspire agent init` コマンドは AI 開発環境を検出し、適切な構成ファイルを作成します: -### Aspire skill file +### Aspire ワークフロースキルファイル + +Aspire ワークフロースキルは、AI コーディングエージェントが Aspire を扱う方法を教えます。トップレベルの `aspire` スキルは、初期化、オーケストレーション、監視、デプロイ、AppHost 配線向けの専用スキルにリクエストをルーティングします。 -スキルファイルは、AI コーディングエージェントが Aspire を扱う方法を教えます。CLI コマンドリファレンス、主要ワークフロー（アプリ起動、問題のデバッグ、統合の追加）、および従うべき重要なルールが含まれます。ファイルは、選択した各スキル配置先にインストールされます: +たとえば、標準の配置先には次のファイルが含まれます: -- .agents/skills/aspire/ - - SKILL.md Standard（VS Code、GitHub Copilot、OpenCode） -- .github/skills/aspire/ - - SKILL.md GitHub Copilot（旧来の配置先） -- .claude/skills/aspire/ - - SKILL.md Claude Code -- .opencode/skill/aspire/ - - SKILL.md OpenCode +- .agents/skills/ + - aspire/ + - SKILL.md + - aspire-init/ + - SKILL.md + - aspire-orchestration/ + - SKILL.md + - aspire-monitoring/ + - SKILL.md + - aspire-deployment/ + - SKILL.md + - aspireify/ + - SKILL.md -このスキルファイルは、次の方法をエージェントにガイドします: +これらのスキルは、次の方法をエージェントにガイドします: - Aspire アプリケーションの起動と管理（`aspire start`、`aspire stop`、`aspire describe`） - 構造化ログと分散トレースを使った問題のデバッグ - `aspire add` による統合追加と `aspire docs` によるドキュメント検索 - データベースクエリなど、リソース固有の操作に向けたリソース MCP ツールの利用 +- 初回セットアップ、AppHost 配線、監視、オーケストレーション、デプロイ作業を専用ワークフローへルーティング ### dotnet-inspect skill -`dotnet-inspect` スキルは、[`dotnet-inspect`](https://github.com/richlander/dotnet-inspect) ツールを使って .NET API サーフェスをクエリする方法を AI エージェントに教えます。これは選択した各配置先で Aspire スキルと並んでインストールされます: +`dotnet-inspect` コンパニオンスキルは、[`dotnet-inspect`](https://github.com/richlander/dotnet-inspect) ツールを使って .NET API サーフェスをクエリする方法を AI エージェントに教えます。選択した場合、選択した各配置先にインストールされます: @@ -102,8 +119,8 @@ Aspire CLI はエージェント主導のワークフロー向けに設計され このスキルにより、エージェントは NuGet パッケージ API サーフェスの調査、パッケージバージョン間の API 変更比較、.NET の型とメンバーの探索が可能になります。 -:::note[スキル競合] -`dotnet-inspect` スキルは Aspire スキルと併せてインストールしないでください。Aspire スキルにはすでに `aspire docs api` サブコマンドのサポートが含まれており、C# と TypeScript の両方で Aspire API を問い合わせる強力な手段を提供します。 +:::note[dotnet-inspect を使う場合] +エージェントに広範な .NET API サーフェスのクエリが必要な場合は `dotnet-inspect` をインストールします。Aspire 固有の API ドキュメントについては、Aspire スキルが C# と TypeScript の両方で `aspire docs api` コマンドを使うようエージェントをガイドします。 ::: ### Aspire MCP server @@ -116,9 +133,9 @@ MCP サーバーは、実行中の Aspire アプリケーションに対する -1. `aspire agent init` を実行し、**Install Aspire skill file** を選択します。 +1. `aspire agent init` を実行し、インストールする Aspire ワークフロースキルを選択します。 -2. スキルファイルは `.github/skills/aspire/SKILL.md` と `.claude/skills/aspire/SKILL.md` に作成されます。 +2. スキルファイルは、`.agents/skills/aspire/SKILL.md` や `.agents/skills/aspire-orchestration/SKILL.md` など、選択した各スキル配置先の下に作成されます。 3. 旧 `AGENTS.md` ファイルを確認したうえで削除します。スキルファイルが置き換えます。 diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx index e9d6b9bd7..e4c22ddc3 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx @@ -3,7 +3,11 @@ title: aspire agent init command description: Learn about the aspire agent init command and its usage. This command initializes AI agent configuration for detected agent environments. --- +import AsciinemaPlayer from '@components/AsciinemaPlayer.astro'; +import { Aside } from '@astrojs/starlight/components'; + import Include from '@components/Include.astro'; +import LearnMore from '@components/LearnMore.astro'; ## Name @@ -15,16 +19,63 @@ import Include from '@components/Include.astro'; aspire agent init [options] ``` + + ## Description The `aspire agent init` command initializes Aspire skills, companion tools, and MCP (Model Context Protocol) server configuration for your development environment. It presents an interactive multi-step flow to configure AI coding agent support: 1. **Select skill locations** — choose where skill files are installed (Standard `.agents/skills/`, Claude Code `.claude/skills/`, GitHub Skills `.github/skills/`, OpenCode `.opencode/skill/`). The **Standard** location is the only option that defaults as pre-selected. -2. **Select skills and tools** — choose which skills and companion tools to install, such as Aspire skills and Playwright CLI. Aspire workflow skills are selected by default; optional companion tools can be selected explicitly. +2. **Select skills and tools** — choose which Aspire workflow skills and companion tools to install. The Aspire workflow skills come from the Aspire skills bundle; optional companion tools such as `playwright-cli` and `dotnet-inspect` can be selected explicitly. 3. **Apply selections** — installs the chosen skills into each selected location and sets up the MCP server connection. The command also removes skill files from any locations that were deselected, keeping your workspace clean. + + +### Skills catalog and defaults + +The Aspire skills bundle includes six workflow skills: `aspire`, `aspire-init`, `aspire-orchestration`, `aspire-monitoring`, `aspire-deployment`, and `aspireify`. The CLI reads the bundle catalog, so bundle-provided skills are available in the interactive prompt and through `--skills` by name. + +Standalone `aspire agent init` pre-selects the bundle skills that are safe to add to an existing workspace: `aspire`, `aspire-init`, `aspire-orchestration`, `aspire-monitoring`, and `aspire-deployment`. The `aspireify` skill remains available but opt-in because it's a one-time AppHost wiring workflow. When `aspire init` chains into agent setup, `aspireify` is pre-selected because it is the natural follow-up after adding an AppHost skeleton to an existing repository. + +Remote bundle fetching is off by default in Aspire 13.4. To opt into downloading matching Aspire skills releases from GitHub, enable the preview feature: + +```bash title="Aspire CLI" +aspire config set features.aspireSkillsRemoteFetchEnabled true +``` + +### Installation summary + +When one or more skill files are installed or updated, the command prints a single compact summary instead of one message per skill. For example, a standalone install of the default Aspire workflow skills into the standard workspace and user-level locations reports: + +```text title="Output" +🤖 Installed Aspire agent skills: + Skills: aspire, aspire-deployment, aspire-init, aspire-monitoring, aspire-orchestration + Locations: .agents/skills, ~/.agents/skills +✅ Agent environment configuration complete. +``` + +If a skill install fails, the error message includes the exact skill path that failed. No-op runs, where every selected skill is already up to date, skip the skills and locations summary and print only the final completion message. + + + If bundle validation fails before skill installation, see [Troubleshoot skill + bundle errors](/get-started/aspire-skills/#troubleshoot-skill-bundle-errors). + + ## Options The following options are available: @@ -39,7 +90,7 @@ The following options are available: - **`--skills `** - Comma-separated list of skills to enable, such as `aspire`, `aspire-init`, `aspire-orchestration`, `aspire-monitoring`, `aspire-deployment`, `aspireify`, or `playwright-cli`. The available list can vary by Aspire CLI version and project type. Use `all` to enable all available skills or `none` to skip skill installation. When not specified, the command prompts interactively. + Comma-separated list of skills to install. Aspire 13.4 includes the Aspire workflow skills `aspire`, `aspire-init`, `aspire-orchestration`, `aspire-monitoring`, `aspire-deployment`, and `aspireify`; companion options can include `playwright-cli` and, for .NET AppHosts, `dotnet-inspect`. The available list can vary by Aspire CLI version and project type. Use `all` to install all available skills or `none` to skip skill installation. When not specified, the command prompts interactively. - @@ -61,7 +112,13 @@ The following options are available: aspire agent init ``` -- Install all supported Aspire skills in all supported skill locations: +- Install all Aspire workflow skills from the Aspire skills bundle in the standard location: + + ```bash title="Aspire CLI" + aspire agent init --skill-locations standard --skills aspire,aspire-init,aspire-orchestration,aspire-monitoring,aspire-deployment,aspireify + ``` + +- Install all available skills and companion options in all supported skill locations: ```bash title="Aspire CLI" aspire agent init --skills all --skill-locations all diff --git a/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md b/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md index a8a23dbf6..196ad887a 100644 --- a/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md +++ b/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md @@ -2,15 +2,16 @@ title: Config Settings Table --- -| Logical key | Stored in `aspire.config.json` as | Description | -| -------------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `appHost.path` | `appHost.path` | Project-scoped path to the default AppHost entry point. This setting must be configured in the local `aspire.config.json` file. | -| `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.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. | +| Logical key | Stored in `aspire.config.json` as | Description | +| ----------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `appHost.path` | `appHost.path` | Project-scoped path to the default AppHost entry point. This setting must be configured in the local `aspire.config.json` file. | +| `channel` | `channel` | Default Aspire channel used by channel-aware commands such as `aspire new`, `aspire init`, and `aspire update`. | +| `features.aspireSkillsRemoteFetchEnabled` | `features.aspireSkillsRemoteFetchEnabled` | Enable or disable preview remote fetching of Aspire skills bundles from GitHub. | +| `features.defaultWatchEnabled` | `features.defaultWatchEnabled` | Enable or disable watch mode by default when running Aspire applications for automatic restarts on file changes. | +| `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. | diff --git a/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx b/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx index 4885dc3c4..0abf76df2 100644 --- a/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx +++ b/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx @@ -1,6 +1,6 @@ --- title: "What's new in Aspire 13.4" -description: "Explore Aspire 13.4: GA TypeScript AppHost, richer Kubernetes and AKS deployment APIs, process resource commands, CLI integration discovery, and dashboard updates." +description: 'Explore Aspire 13.4: GA TypeScript AppHost, richer Kubernetes and AKS deployment APIs, AI agent readiness, process resource commands, CLI integration discovery, and dashboard updates.' sidebar: label: Aspire 13.4 order: 0 @@ -19,7 +19,7 @@ import { import LearnMore from '@components/LearnMore.astro'; import OsAwareTabs from '@components/OsAwareTabs.astro'; -Aspire 13.4 is here, with a release focused on broadening the app model and smoothing day-to-day operations — led by **TypeScript AppHost support reaching general availability**, a new set of **TypeScript samples**, **TypeScript documentation parity with C#**, expanded **Kubernetes and AKS deployment APIs**, **process-backed resource commands**, **integration discovery** from the CLI, server-side **log and telemetry search**, a dashboard **AI Agents** entry point, and a more capable Aspire extension for Visual Studio Code. +Aspire 13.4 is here, with a release focused on broadening the app model and smoothing day-to-day operations — led by **TypeScript AppHost support reaching general availability**, a new set of **TypeScript samples**, **TypeScript documentation parity with C#**, expanded **Kubernetes and AKS deployment APIs**, **AI agent readiness** through the Aspire skills bundle, **process-backed resource commands**, **integration discovery** from the CLI, server-side **log and telemetry search**, a dashboard **AI Agents** entry point, and a more capable Aspire extension for Visual Studio Code. We'd love to hear what you think. Drop by [ Discord](https://aka.ms/aspire-discord) to chat with the team and the community, or file feedback and issues on [ GitHub](https://github.com/microsoft/aspire/issues). @@ -27,6 +27,7 @@ This release introduces: - **TypeScript AppHost general availability** with stronger startup validation, more complete TypeScript SDK generation, new TypeScript samples, and documentation parity with C# AppHost examples. - **Kubernetes and AKS deployment improvements** including [cert-manager integration, Gateway API and Azure Application Gateway for Containers (AGC) support](/deployment/kubernetes/aks/#expose-your-app-to-the-internet), Kubernetes manifest resources, external Helm charts, and consolidated Helm chart configuration. +- **AI agent readiness** with Aspire workflow skills moving into the new [`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills) bundle, clearer separation between first-run setup, lifecycle orchestration, monitoring, AppHost wiring, and deployment guidance, and eval-driven iteration on agent routing. - **Richer resource commands** with typed arguments, visibility controls, immediate result display, named CLI options, resource-scoped help, built-in parameter command options, and the experimental `WithProcessCommand` API. - **CLI discoverability and diagnostics** with `aspire integration list`, `aspire integration search`, `--search` for logs and telemetry, version checks in `aspire doctor`, better logs output, and more consistent command error handling. - **Dashboard and editor updates** including the AI Agents dialog, resource state fixes, CodeLens actions that appear without opening the Aspire panel, and improved VS Code terminal/debug output integration. @@ -56,19 +57,20 @@ This release introduces: Aspire CLI itself **before** running `aspire update` on your project. Running `aspire update` first will fail mid-update with an error like: - ```text - ❌ An unexpected error occurred: No code generator found for language: TypeScript - ``` +```text +❌ An unexpected error occurred: No code generator found for language: TypeScript +``` + +The 13.3.x CLI bundles an AppHost server that cannot load the 13.4 TypeScript +code generator, so package restore succeeds but TypeScript SDK regeneration +crashes. The failure leaves `aspire.config.json` pointing at 13.4 packages +while the CLI is still 13.3.x, which also breaks `aspire run` and +`aspire restore` until you finish the upgrade with `aspire update --self`. - The 13.3.x CLI bundles an AppHost server that cannot load the 13.4 TypeScript - code generator, so package restore succeeds but TypeScript SDK regeneration - crashes. The failure leaves `aspire.config.json` pointing at 13.4 packages - while the CLI is still 13.3.x, which also breaks `aspire run` and - `aspire restore` until you finish the upgrade with `aspire update --self`. +Follow the steps below in order — `aspire update --self` first, then +`aspire update`. See [microsoft/aspire#17077](https://github.com/microsoft/aspire/issues/17077) +for background. - Follow the steps below in order — `aspire update --self` first, then - `aspire update`. See [microsoft/aspire#17077](https://github.com/microsoft/aspire/issues/17077) - for background. For general purpose upgrade guidance, see [Upgrade Aspire](/whats-new/upgrade-aspire/). @@ -191,6 +193,24 @@ Boolean resource command options require explicit `true` or `false` values. For resource`](/reference/cli/commands/aspire-resource/#built-in-parameter-commands). +### AI agent readiness with Aspire skills + +The Aspire workflow skills installed by `aspire agent init` are now packaged as the Aspire skills bundle from [`microsoft/aspire-skills`](https://github.com/microsoft/aspire-skills). The bundle includes six workflow skills: `aspire`, `aspire-init`, `aspire-orchestration`, `aspire-monitoring`, `aspire-deployment`, and `aspireify`. Aspire 13.4 includes an embedded snapshot for default installs, and the optional remote fetch path can download matching GitHub release assets instead of relying only on skill content baked directly into the CLI binary. The CLI verifies bundle integrity before installing selected files. The install flow remains unchanged. + +This split gives agents focused instructions for first-run setup, local lifecycle management, telemetry investigation, deployment, and AppHost wiring instead of loading one broad playbook for every Aspire task. The dedicated skills repository also gives the Aspire team a place to iterate on routing descriptions, trigger phrases, scenario evals, and handoff rules as agent workflows evolve. + +```bash title="Aspire CLI — Install Aspire workflow skills" +aspire agent init --skill-locations standard --skills aspire,aspire-init,aspire-orchestration,aspire-monitoring,aspire-deployment,aspireify +``` + + + For full `aspire agent init` usage and options, see [aspire agent init + command](/reference/cli/commands/aspire-agent-init/). For the skills setup + walkthrough, see [Use AI coding agents](/get-started/ai-coding-agents/). To + follow bundle development, see the [`microsoft/aspire-skills` + repository](https://github.com/microsoft/aspire-skills). + + ### CLI quality-of-life Aspire 13.4 includes a set of smaller CLI improvements and fixes: @@ -303,7 +323,9 @@ Kubernetes and AKS deployment continue to expand in 13.4. Kubernetes environment For AKS, `AddAzureKubernetesEnvironment` now wires Azure Application Gateway for Containers (AGC) into the deployment flow. When `AddLoadBalancer(...)` is used, Aspire provisions the AGC ingress profile on AKS, assigns the required Network Contributor role to the controller identity, and exposes Gateway API routing for the application. - For a complete walkthrough including custom domains, see [Deploy to AKS — Expose your app to the internet](/deployment/kubernetes/aks/#expose-your-app-to-the-internet). + For a complete walkthrough including custom domains, see [Deploy to AKS — + Expose your app to the + internet](/deployment/kubernetes/aks/#expose-your-app-to-the-internet). ### Kubernetes manifests and external Helm charts