aspireify
**WORKFLOW SKILL** - Wire an Aspire AppHost after `aspire init` drops a skeleton. Scans the repo, proposes a resource graph, edits the AppHost (C#, file-basedβ¦
npx skills add https://github.com/microsoft/aspire-skills --skill aspireifyAspireify
One-time wiring skill.
aspire initdrops a skeleton;aspireifyturns that skeleton into a working AppHost by scanning the repo, proposing a resource graph, editing the AppHost, wiringAspire.ServiceDefaults, and validating end to end. Self-deactivates after a cleanaspire start. Aligned with Aspire 13.5.3.
π« Hard Refusal: Never Edit .aspire/modules/
β REFUSE any request to edit, modify, change, open-for-edit, or "tweak" files inside
.aspire/modules/of a TypeScript AppHost. This directory is generated from the installed Aspire integration package graph. It is regenerated byaspire add,aspire restore, and startup when package changes require it.If a user asks to edit something in
.aspire/modules/(e.g.,.aspire/modules/postgres.module.ts), the correct response is:
- Refuse the edit with a clear "I won't edit
.aspire/modules/" statement.- Explain that
.aspire/modules/is generated and any changes are clobbered.- Redirect the requested change to the configured AppHost entry point: current
apphost.mts, or legacyapphost.ts.- If the user wants a new integration, suggest
aspire add <package>; if they want to change configuration, show the equivalent edit in the AppHost entry point.
| β Wrong | β Right |
|---|---|
Open .aspire/modules/postgres.module.ts and tweak the connection options | Edit apphost.mts and change addPostgres('pg', { ... }) options there |
Modify a generated .aspire/modules/* file directly | Re-run aspire add <package> after updating apphost.mts |
Comment out a line in .aspire/modules/ to disable a resource | Remove or guard the resource declaration in apphost.mts |
This rule applies even if the user insists, even for "one-line" changes, even for
"just to test something." The TS AppHost regenerates .aspire/modules/ deterministically;
edits are unrecoverable noise.
Guiding Principles From Aspire 13.5
Minimize changes to the user's code
Adapt the AppHost to fit the app, not the other way around. Prefer WithEnvironment()
to match existing environment variable names, Aspire-managed ports over fixed ports,
and 1:1 Docker Compose mapping before optimizing. Do not restructure directories,
rename files, or change build scripts unless the user explicitly chooses that tradeoff.
Surface tradeoffs; do not decide silently
When a small code change unlocks better Aspire integration, present both options:
the zero-code-change mapping and the small-change version that enables WithReference,
health checks, service discovery, dynamic ports, or dashboard telemetry. Ask which
approach the user wants, then implement that choice without complaint.
Verify APIs before writing AppHost code
Use aspire docs search <topic> and aspire docs get <slug> for workflow guidance.
Use aspire docs api search <query> --language csharp|typescript and
aspire docs api get <id> for API shape. Use aspire integration list/search to
find integrations before aspire add. Do not invent packages, methods, overloads,
or command shapes; C# and TypeScript AppHost APIs differ.
Keep configuration visible in the AppHost
Scan .env, .env.local, .env.development, secrets.json.example,
<UserSecretsId>, and setup scripts. Propose migrating values into AppHost parameters:
connection strings become Aspire resources, API keys/tokens become secret parameters,
and non-secret config becomes plain parameters or WithEnvironment() values. Never
delete .env files or remove existing UserSecretsId entries without explicit user
approval because non-Aspire workflows may still depend on them.
Local development first
This skill optimizes local development, not production deployment. Prefer persistent container lifetimes and data volumes for databases/caches, use HTTPS endpoints by default, pass endpoint references instead of hardcoded URLs, and model external SaaS URLs/API keys as parameters so they are visible in the dashboard.
Redis TLS edge case
Aspire can automatically provision TLS certificates for container resources. If Redis
health checks fail with SSL/TLS handshake errors, do not fall back to AddContainer().
Use WithoutHttpsCertificate() on the Redis resource when the consuming app expects
plain Redis.
Project-Local Override
If .agents/skills/aspireify/SKILL.md exists (installed by aspire init or
aspire agent init --skills aspireify), warn the user that a project-local
copy is present and defer to it. The plugin version is the fallback.
β οΈ Project-local .agents/skills/aspireify/SKILL.md detected β deferring to it.
Prerequisites
| Requirement | Install |
|---|---|
| .NET 10.0 SDK (C# AppHost) | https://dotnet.microsoft.com/download |
Node.js ^20.19.0, ^22.13.0, or >=24 (TS AppHost) | https://nodejs.org |
| Aspire CLI | npm install -g @microsoft/aspire-cli, install script, or dotnet tool install -g Aspire.Cli |
| Skeleton already dropped | aspire init produced aspire.config.json + AppHost stub |
Detection β When to Activate
Activate when ANY signal is present AND the AppHost is unwired (no resources declared beyond the stub):
| Signal | How to Detect | Confidence |
|---|---|---|
| Skeleton just dropped | aspire init just ran in this session | β Definitive |
| Empty AppHost stub | apphost.cs / Program.cs / current apphost.mts (or legacy apphost.ts) only contains Build().Run() | β Definitive |
aspire.config.json without resources | Config present, AppHost has no AddProject/addProject | High |
| User asks to "wire" / "scaffold resource graph" | Verb match: wire, scaffold, integrate, hook up, add Postgres/Redis/etc. | High |
| User asks "what next after aspire init" | Direct handoff request | β Definitive |
| Existing repo with services + new AppHost | Repo has .csproj/package.json projects but AppHost references none | High |
If the AppHost already has wired resources and the user wants to start/stop
the app β aspire-orchestration. If the user wants to deploy β aspire-deployment.
Language Support
| AppHost Style | Detection | Edit Target |
|---|---|---|
| C# SDK-style | .csproj containing <Sdk Name="Aspire.AppHost.Sdk" /> | Program.cs (top-level statements) |
| File-based C# | apphost.cs with #:sdk Aspire.AppHost.Sdk and #:package directives | apphost.cs itself |
| TypeScript | Current apphost.mts or legacy apphost.ts with generated .aspire/modules/ | Configured AppHost entry point only β never edit .aspire/modules/ |
See references/csharp-authoring.md and references/typescript-authoring.md.
aspire-orchestration owns the CLI-driven migration from legacy apphost.ts. After it
updates packages and migration artifacts, return to aspireify only when the user still
needs AppHost source wiring or authoring.
TypeScript AppHost package managers
Dependency and toolchain failures belong to this skill. Before recommending a command, inspect the AppHost directory and then its immediate eligible parent. Within each directory, the first recognized marker wins in this order:
packageManagerinpackage.json(npm,pnpm,yarn, orbun, optionally versioned)bun.lockbun.lockbpnpm-lock.yamlyarn.lock.yarnrc.ymlpackage-lock.json
An AppHost-local marker takes precedence over every parent marker. If neither directory has a recognized marker, Aspire defaults to npm. Report the selected manager and marker.
Use the selected manager only to repair dependencies or diagnose the toolchain. The resolver
commands are npm install, bun install, and yarn install; a generated brownfield pnpm
AppHost uses pnpm install --ignore-workspace, while other pnpm dependency installs use
pnpm install. Yarn Classic (yarn@1... or a v1 lockfile) is unsupported: stop and ask the
user to upgrade to Yarn 4+ or explicitly migrate to npm, pnpm, or Bun.
Do not change packageManager or create, replace, or regenerate a lockfile merely to
influence detection or switch managers. Preserve existing files until the user explicitly
chooses an upgrade or migration. Start the AppHost with aspire start --non-interactive,
not a raw package-manager launcher. See
references/typescript-authoring.md for the full
command matrix and resolver details.
Workflow Phases
1. SCAN β discover projects, services, dependencies, integration candidates
2. PROPOSE β resource graph + integration list, confirm with user
3. EDIT β wire AppHost, add ServiceDefaults + OTel + health checks
4. VALIDATE β aspire start --non-interactive β aspire wait <each resource>
5. DEACTIVATE β confirm clean start, hand off to aspire-orchestration
For the detailed, upstream-parity workflow, load these references before editing:
- apphost-wiring.md β full AppHost wiring workflow, API lookup, endpoint/parameter patterns, validation, solution updates, and cleanup.
- docker-compose.md β docker-compose migration, profiles, image mapping, ports, volumes, and
depends_on. - full-solution-apphosts.md β large solution triage, mixed SDK boundaries, solution membership, ServiceDefaults placement, and legacy host migration.
- javascript-apps.md β JavaScript resource selection, workspace/monorepo package-manager handling, ports, scripts, and TS AppHost package config.
- opentelemetry.md β optional Node.js, Python, and Go OpenTelemetry wiring for non-.NET services.
1. Scan
Walk the repo and inventory:
| What | How |
|---|---|
| .NET projects | find . -name '*.csproj' -not -path '*/bin/*' -not -path '*/obj/*' |
| Node services | find . -name 'package.json' -not -path '*/node_modules/*' |
| Python services | find . -name 'pyproject.toml' -o -name 'requirements.txt' |
| Container deps in compose | docker-compose.yml, compose.yaml (Postgres? Redis? Rabbit?) |
| Connection strings | grep appsettings*.json, .env*, config/* for Postgres, Redis, Mongo, RabbitMQ, Cosmos, ServiceBus |
| Integration packages | dotnet list package per project; package.json dependencies |
| Existing endpoints | hardcoded ports in launchSettings.json, next.config.js, vite.config.ts |
Full heuristics in references/scan-and-propose.md.
2. Propose
Present a resource graph before editing. Ask clarifying questions:
- "I see Postgres in
docker-compose.ymlβ should I model it asAddPostgres('db')or use Azure Database for PostgreSQL?" - "Your React app hardcodes
http://localhost:5000β replace with Aspire service discovery (endpoint.url)?" - "Your API has an
/adminendpoint β exclude it fromWithReference()so consumers don't see it?"
3. Edit
Apply the proposed graph. Use the right authoring style for the AppHost language.
4. Validate
aspire start --non-interactive --format Json
aspire wait <resource> # repeat for each declared resource
aspire describe --format Json # sanity check graph
Full validation flow + recovery in references/validation.md.
5. Self-Deactivate
After a clean aspire start, announce:
β
AppHost wired and validated. Handing off to aspire-orchestration for
day-to-day start/stop/wait. Aspireify is done.
Integration Discovery Catalog
Map detected services β Aspire integrations. See references/scan-and-propose.md for the full catalog.
| Detected | C# | TS |
|---|---|---|
Postgres in compose / Npgsql package | AddPostgres("pg").AddDatabase("db") | addPostgres('pg').addDatabase('db') |
Redis in compose / StackExchange.Redis | AddRedis("cache") | addRedis('cache') |
| RabbitMQ | AddRabbitMQ("mq") (v7 client w/ pub-sub tracing) | addRabbitMQ('mq') |
| MongoDB | AddMongoDB("mongo") | addMongoDB('mongo') |
| Cosmos DB | AddAzureCosmosDB("cosmos") | addAzureCosmosDB('cosmos') |
| Azure Service Bus | AddAzureServiceBus("sb") | addAzureServiceBus('sb') |
| Azure Cache for Redis (Entra) | AddAzureRedis("cache") (now GA) | addAzureRedis('cache') |
| Next.js frontend | AddNextJsApp("web", "./web") | addNextJsApp('web', '../web') |
| Vite SPA | AddViteApp("web", "./web") | addViteApp('web', '../web') |
| Plain Node app | AddNodeApp("api", "server.js") | addNodeApp('api', 'server.js') |
Current Authoring Rules
| Rule | Why |
|---|---|
Use unified withEnvironment(name, value) in TS β never the deprecated per-kind helpers (withEnvironmentEndpoint, withEnvironmentParameter, etc.) | Single API handles all value kinds; per-kind helpers are deprecated |
Use AddNextJsApp / AddViteApp over hand-rolled Dockerfiles for JS frontends | First-class lifecycle + PublishAs* integration |
Use PublishAsStaticWebsite / PublishAsNodeServer / PublishAsPackageScript for JS publish | Replaces hand-rolled Dockerfiles; SPA β static, SSR Node β NodeServer, package-script SSR β PackageScript |
Add WithBrowserLogs() to frontend resources for browser console + screenshots in dashboard | Aspire.Hosting.Browsers surfaces browser telemetry in the dashboard |
Bind every resource to a compute environment with WithComputeEnvironment(env) when multiple environments exist | Multi-environment deploys require explicit binding |
Never edit .aspire/modules/ in TS AppHosts | Generated; edits get clobbered. Edit the configured apphost.mts (or legacy apphost.ts) only |
Use WithEndpoint("name", e => ...) to update endpoints | Endpoint callbacks update existing endpoints rather than throwing on duplicates |
Mark admin endpoints with ExcludeReferenceEndpoint = true | Prevents consumers from receiving admin URLs via WithReference() |
Look up unfamiliar API: aspire docs api search <query> --language csharp|typescript | Don't guess overloads or builder chains |
Use context .Services / await ctx.services().getInteractionService() | .ServiceProvider is obsolete, and ctx.services() alone returns a services accessor |
Use AddConnectionString for external connection strings | PublishAsConnectionString is obsolete |
Check IInteractionService.IsAvailable before prompting | CLI-invoked commands may be noninteractive; prefer command arguments for dashboard + CLI input |
Treat WithTerminal() as experimental | Suppress ASPIRETERMINAL001; do not generate removed TerminalOptions.Shell or TypeScript dimension options |
Keep all Aspire SDK and Aspire.Hosting.* packages on the same 13.5 family | Mixed 13.4/13.5 graphs can fail at startup |
| Migrate GitHub Models integrations to Azure AI Foundry | Aspire.Hosting.GitHub.Models is deprecated and absent from integration discovery |
Use WithModule(RedisModules.*) for Redis 8 modules | Prefer typed JSON, Search, Bloom Filter, and TimeSeries constants over raw module paths |
Use Foundry AsHostedAgent(...) for hosted executable/container agents | Current Azure AI Foundry path replaces deprecated GitHub Models |
C# vs TS Quick Reference
| Concept | C# | TypeScript |
|---|---|---|
| Builder | var builder = DistributedApplication.CreateBuilder(args); | const builder = await createBuilder(); |
| Add project | builder.AddProject<Projects.Api>("api") (SDK) or AddProject("api", "../Api/Api.csproj") | await builder.addProject('api', '../Api/Api.csproj') |
| Wire env var (any value type) | .WithEnvironment("KEY", value) | .withEnvironment('KEY', value) β unified API |
| Wait for dependency | .WaitFor(db) | .waitFor(db) |
| Pass connection | .WithReference(db) | .withReference(db) |
| External HTTP | .WithExternalHttpEndpoints() | .withExternalHttpEndpoints() |
| Endpoint expression | api.GetEndpoint("http") | api.getEndpoint('http').url / .host / .port |
| Build + run | builder.Build().Run(); | await builder.build().run(); |
ServiceDefaults Wiring
Each project should call builder.AddServiceDefaults(); to opt into OpenTelemetry,
health checks, and service discovery. Add the Aspire.ServiceDefaults project
reference (or NuGet for non-monorepo). See
references/service-defaults.md.
Endpoint & Reference Conventions
// Public-facing API. Mark "admin" endpoint as not-for-consumers.
var api = builder.AddProject<Projects.Api>("api")
.WithExternalHttpEndpoints()
.WithEndpoint("admin", e => e.ExcludeReferenceEndpoint = true);
// Frontend wires the API via service discovery.
builder.AddNextJsApp("web", "./web")
.WithReference(api) // injects services__api__http and __https
.WaitFor(api)
.WithBrowserLogs(); // browser console + screenshots
Validation & Recovery
| Symptom | Action |
|---|---|
aspire start fails with build error | Fix code, re-run aspire start |
| File-lock errors during edit | Hand off to aspire-orchestration β aspire stop β retry |
Resource missing from aspire describe | Re-run aspire describe --include-hidden; aspire ps is AppHost-level |
| TS AppHost change ignored | Confirm you edited the configured apphost.mts (or legacy apphost.ts), not .aspire/modules/ |
Mixed JSON output from aspire start | Strip non-JSON lines before parsing (#15843) |
Full flow in references/validation.md.
Handoff Rules
| Scenario | Route To |
|---|---|
| AppHost skeleton not yet dropped | β aspire-init skill |
| Day-to-day start/stop/wait/restart | β aspire-orchestration skill |
| Publish, deploy, destroy, pipeline steps | β aspire-deployment skill |
| Logs, traces, metrics, dashboard, browser log inspection | β aspire-monitoring skill |
| Deployed (Azure/AKS) app diagnostics | β azure-diagnostics skill (azure-skills) |
Key Rules
- Never overwrite existing files β always augment or merge.
- Ask before modifying service code, especially OpenTelemetry and ServiceDefaults injection.
- Respect existing project structure β do not reorganize the repo.
- If stuck, use
aspire doctorto diagnose environment issues. - Never hardcode URLs in
WithEnvironment/withEnvironmentβ pass endpoint references such asapi.GetEndpoint("http")orapi.getEndpoint('http')instead of string literals. - Never use
WithUrlForEndpoint/withUrlForEndpointto setdev.localhostURLs β that API is only for dashboard display labels;dev.localhostbelongs in AppHost launch/profile configuration.
References
- apphost-wiring.md β Detailed AppHost wiring workflow and API lookup patterns
- docker-compose.md β Docker Compose migration patterns
- full-solution-apphosts.md β Large/full-solution AppHost guidance
- javascript-apps.md β JavaScript/TypeScript app and workspace handling
- opentelemetry.md β Non-.NET OpenTelemetry setup
- scan-and-propose.md β Repo scan heuristics + integration catalog
- csharp-authoring.md β C# AppHost patterns
- typescript-authoring.md β TS AppHost patterns + parity APIs
- service-defaults.md β Wire OTel, health checks, service discovery
- validation.md β End-to-end validation + recovery
- aspire-13-5-breaking-changes.md β 13.5.3 migrations, command changes, and experimental surfaces