Files
plan2code/QUICK-REFERENCE.md
T

129 lines
7.3 KiB
Markdown
Raw Normal View History

# Plan2Code Quick Reference
2025-12-23 15:42:35 -08:00
## Commands
| Step | Command | Input | Output |
| -------- | ------------------------------- | --------------- | --------------------------------------------------------------------------------------- |
| — | /plan2code | None | Web console dashboard — a menu of every skill below, launched on the page |
| Init | /plan2code-init | None | AGENTS.md file |
| Update | /plan2code-init-update | AGENTS.md | Updated AGENTS.md |
| 0 | /plan2code-0-pathfinder | A foggy idea | pathfinder/map.md *or* GitHub Issues + PLAN-DRAFT-<date>.md |
| quick | /plan2code-quick-task | Requirements | Conversational plan (standalone — not a pipeline step) |
| review | /plan2code-review | Scope guidance | Review findings + fixes |
| 1 | /plan2code-1-plan | Requirements | PLAN-CONVERSATION-<date>.md + PLAN-DRAFT-<date>.md |
| 1b | /plan2code-1b-revise-plan | Specs + changes | Updated specs |
| 2 | /plan2code-2-document | PLAN-DRAFT.md | overview.md + Phase files |
| 3 | /plan2code-3-implement | overview.md | Implemented code |
| 3+review | /plan2code-3-implement-review | overview.md | Reviewed implementation ready for approval (alternative to `/plan2code-3-implement`) |
| 4 | /plan2code-4-finalize | overview.md | Archived specs |
| handoff | /plan2code-handoff | Conversation | Self-contained handoff doc in handoffs/ |
Append ` --web` to any step to work through it in the browser web console instead of the terminal — or run `/plan2code` with nothing for the dashboard, a menu of every skill that launches your pick on the same page. See [.readme/web-console.md](.readme/web-console.md).
2025-12-23 15:42:35 -08:00
## File Structure
```
specs/
└── <feature-name>/
2026-08-08 19:00:26 -07:00
├── pathfinder/ # From Step 0 (optional, if charted locally)
│ ├── map.md # the map: destination, decisions, fog
│ ├── questions/NN-<slug>.md # one decision question per file
│ └── briefs/brief-<date>.md # on-demand plain-English decision briefs
2026-08-08 19:00:26 -07:00
│ # (GitHub Issues backend: map issue + sub-issues instead)
2026-02-17 09:13:23 -08:00
├── PLAN-DRAFT-<date>.md # From Step 1 (verified plan)
├── PLAN-CONVERSATION-<date>.md # From Step 1 (conversation log)
├── overview.md # From Step 2
└── phase-X.md # From Step 2
2025-12-23 15:42:35 -08:00
2026-02-17 09:13:23 -08:00
specs--completed/ # After Step 4
└── <feature-name>/ # Archived specs
2025-12-23 15:42:35 -08:00
```
2026-02-17 09:13:23 -08:00
Note: `<date>` uses YYYYMMDD format (e.g., `20250204`)
2025-12-23 15:42:35 -08:00
## Key Rules
- Start NEW conversation for each step (and each implementation phase)
2026-01-27 12:11:00 -08:00
- ONE phase per conversation (but parallel phases can run in separate instances)
2025-12-23 15:42:35 -08:00
- Reply "approved" to complete phases
- 90% confidence required before planning completes
- Never look in `specs--completed/` (it's archived specs)
2026-01-27 12:11:00 -08:00
## Phase Status
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
| Checkbox | Status | Meaning |
|----------|--------|---------|
| `[ ]` | Pending | Not started |
| `[/]` | In Progress | Agent working (or paused) |
| `[x]` | Complete | Approved |
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
## Parallel Execution
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
When phases have no file conflicts or dependencies, they can run simultaneously:
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
1. Documentation Mode auto-detects parallel-eligible phases
2. Implementation Mode shows selection UI with status for each phase
3. Run multiple `/plan2code-3-implement` instances on different phases
2026-01-27 12:11:00 -08:00
4. `[/]` status shows which phases are actively being worked on
2026-02-03 20:32:18 -08:00
2025-12-23 15:42:35 -08:00
## Quick Troubleshooting
| Issue | Solution |
| ---------------------- | ------------------------------------------------ |
| Lost context mid-phase | Attach spec files, say "resume from Task X.Y" |
| Wrong phase started | Say "abort", start correct phase |
| Need to change plan | Use `/plan2code-1b-revise-plan` |
| Multiple spec folders | Specify which: "Continue with specs/user-auth/" |
| Need AGENTS.md file | Use `/plan2code-init` to generate one |
| Update AGENTS.md | Use `/plan2code-init-update` after sessions |
| Run phases in parallel | Check Parallel Execution Groups in overview.md |
2025-12-23 15:42:35 -08:00
## Workflow Decision
```
New to a project?
└── /plan2code-init → Generate AGENTS.md for project-specific guidance
2025-12-23 15:42:35 -08:00
Learned something during a session?
└── /plan2code-init-update → Add learnings to AGENTS.md
2025-12-23 15:42:35 -08:00
Too foggy to plan? (big idea, don't yet know what the questions are)
└── /plan2code-0-pathfinder → chart it, clear one decision at a time
├── continue-or-stop menu between decisions; fresh session recommended after ~3
└── then → /plan2code-1-plan (resumes at Phase 4)
2025-12-23 15:42:35 -08:00
Is it a quick, small task?
├── Yes → /plan2code-quick-task (standalone)
└── No → /plan2code-1-plan (full workflow)
├── /plan2code-2-document
├── /plan2code-3-implement (repeat per phase)
│ ├── OR: /plan2code-3-implement-review (review gate before approval)
2026-01-27 12:11:00 -08:00
│ └── OR: plan2code-loop (autonomous alternative)
└── /plan2code-4-finalize
2025-12-23 15:42:35 -08:00
Need to revise mid-implementation?
└── /plan2code-1b-revise-plan
2025-12-23 15:42:35 -08:00
```
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
## Autonomous Loop (Alternative)
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
The `plan2code-loop` CLI is an **alternative** to Step 3, not a replacement.
2026-02-03 20:32:18 -08:00
| Approach | Use When |
|-----------------------------------|-------------------------------------------------|
| `/plan2code-3-implement` | You want interactive control per phase |
| `/plan2code-3-implement-review` | You want review and fixes before phase approval |
| `plan2code-loop` | You want hands-off autonomous execution |
2026-02-03 20:32:18 -08:00
2026-01-27 12:11:00 -08:00
```bash
plan2code-loop # Fully interactive - auto-detects specs, prompts for options
```
2026-02-03 20:32:18 -08:00
2026-02-17 09:13:23 -08:00
### Loop Modes
| Mode | Description |
|---------------------------------|----------------------------------------------------------------------------------------------------------|
| **One task per loop** (default) | One task per agent invocation. Node handles git commits. |
| **One phase per loop** | All tasks in a phase per invocation. LLM handles git commits. Best for smart models with larger context. |
2026-02-17 09:13:23 -08:00
2026-01-27 12:11:00 -08:00
Session state stored per-spec in `specs/<feature>/.plan2code-loop/`