mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-07-21 18:33:22 -07:00
v1.5.4
This commit is contained in:
+33
-23
@@ -1,31 +1,34 @@
|
||||
# Plan2Code Quick Reference
|
||||
# Plam2Code Quick Reference
|
||||
|
||||
## Commands
|
||||
|
||||
| Step | Command | Input | Output |
|
||||
| ------ | ---------------------------| --------------- | ------------------------- |
|
||||
| Init | /plan2code---init | None | AGENTS.md file |
|
||||
| Update | /plan2code---init-update | AGENTS.md | Updated AGENTS.md |
|
||||
| 0 | /plan2code---quick-task | Requirements | Conversational plan |
|
||||
| 1 | /plan2code-1--plan | Requirements | PLAN-DRAFT.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 |
|
||||
| 4 | /plan2code-4--finalize | overview.md | Archived specs |
|
||||
| Step | Command | Input | Output |
|
||||
| ------ | ----------------------------- | --------------- | ----------------------------------- |
|
||||
| Init | /plan2code---init | None | AGENTS.md file |
|
||||
| Update | /plan2code---init-update | AGENTS.md | Updated AGENTS.md |
|
||||
| 0 | /plan2code---quick-task | Requirements | Conversational plan |
|
||||
| 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 |
|
||||
| 4 | /plan2code-4--finalize | overview.md | Archived specs |
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
specs/
|
||||
├── PLAN-DRAFT-<timestamp>.md # From Step 1
|
||||
└── <feature-name>/
|
||||
├── overview.md # From Step 2
|
||||
└── Phase X.md # From Step 2
|
||||
├── 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
|
||||
|
||||
specs--completed/ # After Step 4
|
||||
└── <feature-name>/ # Archived specs
|
||||
specs--completed/ # After Step 4
|
||||
└── <feature-name>/ # Archived specs
|
||||
```
|
||||
|
||||
Note: `<date>` uses YYYYMMDD format (e.g., `20250204`)
|
||||
|
||||
## Key Rules
|
||||
|
||||
- Start NEW conversation for each step (and each implementation phase)
|
||||
@@ -53,14 +56,14 @@ When phases have no file conflicts or dependencies, they can run simultaneously:
|
||||
|
||||
## Quick Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
| 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 |
|
||||
| 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 |
|
||||
|
||||
## Workflow Decision
|
||||
@@ -97,4 +100,11 @@ The `plan2code-loop` CLI is an **alternative** to Step 3, not a replacement.
|
||||
plan2code-loop # Fully interactive - auto-detects specs, prompts for options
|
||||
```
|
||||
|
||||
### 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. |
|
||||
|
||||
Session state stored per-spec in `specs/<feature>/.plan2code-loop/`
|
||||
|
||||
Reference in New Issue
Block a user