aspire
Aspire Skill
Use this skill when the task is about operating an Aspire distributed application through the Aspire CLI rather than falling back to ad-hoc dotnet, docker, or shell workflows.
Resources are typically defined in an AppHost such as, AppHost.cs, apphost.ts, or AppHost/AppHost.csproj (Program.cs).
Use this skill for
- Starting, restarting, and stopping AppHosts with
aspire startandaspire stop - Initializing Aspire in an existing app with
aspire init - Inspecting resources, logs, traces, and docs
- Adding integrations with
aspire add - Recovering missing TypeScript AppHost support files with
aspire restore - Discovering the correct frontend URL before a Playwright handoff
- Understanding unfamiliar Aspire AppHost APIs before editing C# or TypeScript AppHosts
- Managing AppHost secrets and CLI config
- Publishing and deploying Aspire apps, including single named steps with
aspire do - Adding custom dashboard or resource commands with docs-backed AppHost patterns
Do not use this skill for
- Non-Aspire .NET applications
- Container-only workflows that do not involve an Aspire AppHost
- Replacing normal build and test commands when the task is just compiling code or running unit tests
Default workflow
- Confirm that the workspace is an Aspire app and identify the AppHost.
- Start the app with
aspire start. Use--isolatedin git worktrees or whenever shared local state would be risky. - Use
aspire wait <resource>before interacting with a resource that needs to be healthy. - Inspect state with
aspire describe, then useaspire otel logs,aspire logs,aspire otel traces, andaspire exportbefore making code changes. - Before adding an integration, introducing a custom dashboard/resource command, or using an unfamiliar AppHost API, use
aspire docs search <topic>andaspire docs get <slug>for workflow guidance, then useaspire docs api search <query> --language csharp|typescriptandaspire docs api get <id>when you need the API reference entry itself. - Re-run
aspire startafter AppHost changes. In git worktrees, re-runaspire start --isolatedinstead of switching toaspire run.
C# AppHosts
When the AppHost is implemented in C# such as AppHost.cs, apphost.cs, or a Program.cs-based AppHost, use Aspire docs for workflow guidance and Aspire API docs for the reference entry before editing.
- Use
aspire docs search <topic>andaspire docs get <slug>when you need the documented workflow or pattern. - Use
aspire docs api search <query> --language csharpandaspire docs api get <id>when you need the C# API reference entry for a resource builder, extension method, or member. - If the
dotnet-inspectskill is available, use it to inspect local C# APIs, overloads, and builder chains when you need help understanding how the API surface is exposed in code. - Keep
dotnet-inspectscoped to understanding APIs and symbols; use Aspire docs for the documented workflow and recommended pattern.
TypeScript AppHosts
When the AppHost is apphost.ts, the .modules/ folder at the project root contains generated TypeScript modules that expose the Aspire APIs available to the AppHost. Common files include .modules/aspire.ts, base.ts, and transport.ts.
- Do not edit
.modules/directly. - Use
aspire add <package>to add integrations and regenerate the available APIs. - Inspect
.modules/aspire.tsafteraspire addto see the refreshed API surface. - The local
tsconfig.jsonoften includes.modules/**/*.tsin its compilation scope.
Key rules
- Prefer
aspire startoverdotnet runfor AppHosts.aspire runblocks the terminal and is a poor fit for agent workflows. - Re-running
aspire startis the restart path. In git worktrees,aspire start --isolatedis both the start and restart command. Do not combineaspire stopandaspire run. - Use
--apphost <path>when the workspace has multiple AppHosts or discovery is ambiguous. - Use
--format Jsonwhen another tool or script needs machine-readable output. - Do not guess the integration or command shape for unfamiliar AppHost changes. Use
aspire docs searchandaspire docs getfor the documented pattern, then useaspire docs api searchandaspire docs api getwhen you need the specific reference entry. - For unfamiliar C# AppHost APIs, use Aspire API docs as the primary reference and, if available, use
dotnet-inspectonly to inspect local symbols, overloads, and builder chains. - Never install the obsolete Aspire workload.
- When a TypeScript AppHost uses
.modules/, do not edit generated files directly. Useaspire addto regenerate APIs and inspect.modules/aspire.tsafterward. - Prefer official docs from
aspire.dev.
Common capabilities
- Use
aspire pswhen you need to discover running AppHosts before targeting one. - Use
aspire updatewhen the task is to refresh AppHost package references through the supported CLI workflow. - Use
aspire doctoras an early diagnostics step when the local Aspire environment looks unhealthy. - Use
aspire resource,aspire secret,aspire config,aspire publish,aspire deploy, andaspire dowhen the objective is resource operations, secrets/config management, or deployment. - Use
aspire restore,aspire cache clear,aspire certs trust, andaspire certs cleanwhen the task is local environment maintenance or recovery.
Playwright CLI
If Playwright CLI is already configured in the environment, use Aspire first to discover the running app and its endpoints, especially when multiple frontends exist. Prefer aspire describe --format Json when the handoff needs to be scriptable or you need to disambiguate which frontend URL Playwright should use, then hand browser testing off to Playwright CLI.
References
- For app-level lifecycle, bootstrap, and AppHost-wide commands, see references/app-commands.md.
- For waiting on and operating on individual resources, see references/resource-management.md.
- For app state, logs, traces, and export workflows, see references/monitoring.md.
- For deployment and pipeline-step workflows, see references/deployment.md.
- For docs, secrets, config, diagnostics, cache, and certificates, see references/tools-and-configuration.md.
- For C# AppHost API-understanding guidance, see references/csharp-apphosts.md.
- For TypeScript AppHost guidance, see references/typescript-apphosts.md.
- For Playwright handoff after Aspire endpoint discovery, see references/playwright-handoff.md.
- For investigation order and common agent workflows, see references/agent-workflows.md.