Skip to content

Commit b8e4691

Browse files
authored
Merge pull request #29 from tmcfarlane/docs/faq-fix
docs: improve formatting and clarity in command usage section of README
2 parents b123632 + 6a3bd3d commit b8e4691

1 file changed

Lines changed: 25 additions & 16 deletions

File tree

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -325,23 +325,22 @@ model: gemini-3.1-pro # multimodal tasks
325325

326326
Type these in Cursor's chat to invoke specific workflows:
327327

328-
| Command | Agent | Purpose |
329-
| --------------- | ------ | ------------------------------------------------------------------------------------------------------- |
330-
| `/plan` | Sokka | Full planning pipeline: ambiguity analysis, plan creation, self-review |
331-
| `/build` | Aang | Deep multi-file implementation with verification |
332-
| `/search` | Toph | Multi-angle codebase + docs exploration |
333-
| `/fix` | Katara | Methodical debugging and code healing |
334-
| `/tasks` | Appa | Systematic task list execution |
335-
| `/scout` | Momo | Quick focused tasks |
336-
| `/doc` | Iroh | Documentation generation and updates |
328+
| Command | Agent | Purpose |
329+
| --------------- | ------ | -------------------------------------------------------------------------------------------------------- |
330+
| `/plan` | Sokka | Full planning pipeline: ambiguity analysis, plan creation, self-review |
331+
| `/build` | Aang | Deep multi-file implementation with verification |
332+
| `/search` | Toph | Multi-angle codebase + docs exploration |
333+
| `/fix` | Katara | Methodical debugging and code healing |
334+
| `/tasks` | Appa | Systematic task list execution |
335+
| `/scout` | Momo | Quick focused tasks |
336+
| `/doc` | Iroh | Documentation generation and updates |
337337
| `/image` | Zuko | Cursor image generation (Nano Banana Pro): icons, mockups, prompts via **cursor-image-generation** skill |
338-
| `/cactus-juice` | Swarm | Decompose into micro-tasks, spawn up to 10 parallel workers |
338+
| `/cactus-juice` | Swarm | Decompose into micro-tasks, spawn up to 10 parallel workers |
339339

340340
### Image generation (Cursor agent)
341341

342342
The agent can generate images via **Google Nano Banana Pro**; previews save under **`assets/`** by default. Team Avatar routes visual generation to **Zuko**, which uses the **`cursor-image-generation`** skill ([`skills/cursor-image-generation/SKILL.md`](skills/cursor-image-generation/SKILL.md)) to **rewrite** short user requests into full prompts, then iterate. Use **`/image`** or delegate **`Task(zuko)`** for image-only work.
343343

344-
345344
## Two Orchestration Modes
346345

347346
### Avatar State (Default)
@@ -458,15 +457,25 @@ Or use slash commands: `/plan add OAuth support with JWT tokens` then `/build ba
458457

459458
## FAQ
460459

461-
**Do I need to manually choose agents?** No — the orchestrator auto-delegates. Slash commands (`/plan`, `/build`, `/fix`, etc.) give explicit control when you want it.
460+
### Do I need to manually choose agents?
461+
462+
No — the orchestrator auto-delegates. Slash commands (`/plan`, `/build`, `/fix`, etc.) give explicit control when you want it.
463+
464+
### Will this work on any Cursor plan?
465+
466+
Yes, if your plan supports agent mode / subagents.
467+
468+
### How do I update?
469+
470+
Re-run the install command with `--force` (or `-Force` on Windows).
462471

463-
**Will this work on any Cursor plan?** Yes, if your plan supports agent mode / subagents.
472+
### How do I uninstall?
464473

465-
**How do I update?** Re-run the install command with `--force` (or `-Force` on Windows).
474+
Re-run with `--uninstall` (or `-Uninstall` on Windows).
466475

467-
**How do I uninstall?** Re-run with `--uninstall` (or `-Uninstall` on Windows).
476+
### Claude Code / Codex?
468477

469-
**Claude Code / Codex?** Yes — install with `--claude --codex` (or `-AlsoClaude -AlsoCodex`).
478+
Yes — install with `--claude --codex` (or `-AlsoClaude -AlsoCodex`).
470479

471480
## Origin Story
472481

0 commit comments

Comments
 (0)