# Nikneem Battleship On Aspire Aspire > Aspire Skill - Skill: `tomevault-io/nikneem-battleship-on-aspire-aspire` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/nikneem-battleship-on-aspire-aspire` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/nikneem-battleship-on-aspire-aspire/raw - Safety review: pending (external: skill-scanner PASS, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Coding & Dev Tools - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/nikneem-battleship-on-aspire-aspire --- # Aspire Skill This repository uses Aspire to orchestrate its distributed application. Resources are defined in the AppHost project (`apphost.cs` or `apphost.ts`). ## TypeScript AppHost (.modules folder) When using a TypeScript AppHost (`apphost.ts`), the `.modules/` folder at the project root contains auto-generated TypeScript modules that expose the Aspire APIs available to `apphost.ts`. Key files include `aspire.ts` (the main API surface with `createBuilder` and resource methods), `base.ts`, and `transport.ts`. - **Do not edit files in `.modules/` directly** — they are regenerated automatically. - To add new APIs (e.g., a new integration), run `aspire add `. This updates the NuGet references and regenerates the `.modules/` folder with the new APIs. - After running `aspire add`, check the updated `.modules/aspire.ts` to discover the newly available APIs. - The `tsconfig.json` includes `.modules/**/*.ts` in its compilation scope. ## CLI command reference | Task | Command | |---|---| | Create a new project | `aspire new` | | Initialize Aspire in existing project | `aspire init` | | Start the app (background) | `aspire start` | | Start isolated (worktrees) | `aspire start --isolated` | | Restart the app | `aspire start` (stops previous automatically) | | Run the app (foreground) | `aspire run` | | Wait for resource healthy | `aspire wait ` | | Wait with custom status/timeout | `aspire wait --status up --timeout 60` | | Stop the app | `aspire stop` | | List resources | `aspire describe` or `aspire resources` | | Run resource command | `aspire resource ` | | Start/stop/restart resource | `aspire resource start\|stop\|restart` | | View console logs | `aspire logs [resource]` | | View structured logs | `aspire otel logs [resource]` | | View traces | `aspire otel traces [resource]` | | View spans | `aspire otel spans [resource]` | | Logs for a trace | `aspire otel logs --trace-id ` | | Export telemetry and resource data to zip | `aspire export [resource]` | | Add an integration | `aspire add` | | List running AppHosts | `aspire ps` | | Update AppHost packages | `aspire update` | | Set a user secret | `aspire secret set ` | | Get a user secret | `aspire secret get ` | | List user secrets | `aspire secret list` | | Set CLI config | `aspire config set ` | | Get CLI config | `aspire config get ` | | List CLI config | `aspire config list` | | Search docs | `aspire docs search ` | | Get doc page | `aspire docs get ` | | List doc pages | `aspire docs list` | | Publish deployment artifacts | `aspire publish` | | Deploy to targets | `aspire deploy` | | Run a pipeline step | `aspire do ` | | Environment diagnostics | `aspire doctor` | | List resource MCP tools | `aspire mcp tools` | | Call resource MCP tool | `aspire mcp call --input ` | | Configure agent integrations | `aspire agent init` | Most commands support `--format Json` for machine-readable output. Use `--apphost ` to target a specific AppHost. ## Key workflows ### Running in agent environments Use `aspire start` to run the AppHost in the background. When working in a git worktree, use `--isolated` to avoid port conflicts and to prevent sharing user secrets or other local state with other running instances: ```bash aspire start --isolated ``` Use `aspire wait ` to block until a resource is healthy before interacting with it: ```bash aspire start --isolated aspire wait myapi ``` Relaunching is safe — `aspire start` automatically stops any previous instance. Re-run `aspire start` whenever changes are made to the AppHost project. ### Debugging issues Before making code changes, inspect the app state: 1. `aspire describe` — check resource status 2. `aspire otel logs ` — view structured logs 3. `aspire logs ` — view console output 4. `aspire otel traces ` — view distributed traces 5. `aspire export` — export telemetry and resource data to a zip for deeper analysis ### Adding integrations Use `aspire docs search` to find integration documentation, then `aspire docs get` to read the full guide. Use `aspire add` to add the integration package to the AppHost. After adding an integration, restart the app with `aspire start` for the new resource to take effect. ### Managing secrets Use `aspire secret` to manage AppHost user secrets for connection strings, passwords, and API keys: ```bash aspire secret set Parameters:postgres-password MySecretValue aspire secret list ``` ### Publishing and deploying Generate deployment artifacts (Bicep, Docker Compose, etc.): ```bash aspire publish ``` Deploy to configured targets: ```bash aspire deploy aspire deploy --clear-cache # reset cached deployment state ``` ### Using resource MCP tools Some resources expose MCP tools (e.g. `WithPostgresMcp()` adds SQL query tools). Discover and call them via CLI: ```bash aspire mcp tools # list available tools aspire mcp tools --format Json # includes input schemas aspire mcp call --input '{"key":"value"}' # invoke a tool ``` ## Important rules - **Always start the app first** (`aspire start`) before making changes to verify the starting state. - **To restart, just run `aspire start` again** — it automatically stops the previous instance. NEVER use `aspire stop` then `aspire run`. NEVER use `aspire run` at all — it blocks the terminal. - Use `--isolated` when working in a worktree. - **Avoid persistent containers** early in development to prevent state management issues. - **Never install the Aspire workload** — it is obsolete. - Prefer `aspire.dev` and `learn.microsoft.com/microsoft/aspire` for official documentation. ## Playwright CLI If configured, use Playwright CLI for functional testing of resources. Get endpoints via `aspire describe`. Run `playwright-cli --help` for available commands. --- > Source: [nikneem/battleship-on-aspire](https://github.com/nikneem/battleship-on-aspire) — distributed by [TomeVault](https://tomevault.io).