docs: update README and docs/ for v1.27 release
Add documentation for all new v1.27 features: - 7 new commands (/gsd:fast, /gsd:review, /gsd:plant-seed, /gsd:thread, /gsd:add-backlog, /gsd:review-backlog, /gsd:pr-branch) - Security hardening (security.cjs, prompt guard hook, workflow guard hook) - Multi-repo workspace support, discussion audit trail, advisor mode - New config options (research_before_questions, hooks.workflow_guard) - Updated component counts in ARCHITECTURE.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
149
docs/COMMANDS.md
149
docs/COMMANDS.md
@@ -44,14 +44,16 @@ Capture implementation decisions before planning.
|
||||
|------|-------------|
|
||||
| `--auto` | Auto-select recommended defaults for all questions |
|
||||
| `--batch` | Group questions for batch intake instead of one-by-one |
|
||||
| `--analyze` | Add trade-off analysis during discussion |
|
||||
|
||||
**Prerequisites:** `.planning/ROADMAP.md` exists
|
||||
**Produces:** `{phase}-CONTEXT.md`
|
||||
**Produces:** `{phase}-CONTEXT.md`, `{phase}-DISCUSSION-LOG.md` (audit trail)
|
||||
|
||||
```bash
|
||||
/gsd:discuss-phase 1 # Interactive discussion for phase 1
|
||||
/gsd:discuss-phase 3 --auto # Auto-select defaults for phase 3
|
||||
/gsd:discuss-phase --batch # Batch mode for current phase
|
||||
/gsd:discuss-phase 2 --analyze # Discussion with trade-off analysis
|
||||
```
|
||||
|
||||
---
|
||||
@@ -609,6 +611,151 @@ Restore local modifications after a GSD update.
|
||||
|
||||
---
|
||||
|
||||
## Fast & Inline Commands
|
||||
|
||||
### `/gsd:fast`
|
||||
|
||||
Execute a trivial task inline — no subagents, no planning overhead. For typo fixes, config changes, small refactors, forgotten commits.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `task description` | No | What to do (prompted if omitted) |
|
||||
|
||||
**Not a replacement for `/gsd:quick`** — use `/gsd:quick` for anything needing research, multi-step planning, or verification.
|
||||
|
||||
```bash
|
||||
/gsd:fast "fix typo in README"
|
||||
/gsd:fast "add .env to gitignore"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Code Quality Commands
|
||||
|
||||
### `/gsd:review`
|
||||
|
||||
Cross-AI peer review of phase plans from external AI CLIs.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `--phase N` | **Yes** | Phase number to review |
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--gemini` | Include Gemini CLI review |
|
||||
| `--claude` | Include Claude CLI review (separate session) |
|
||||
| `--codex` | Include Codex CLI review |
|
||||
| `--all` | Include all available CLIs |
|
||||
|
||||
**Produces:** `{phase}-REVIEWS.md` — consumable by `/gsd:plan-phase --reviews`
|
||||
|
||||
```bash
|
||||
/gsd:review --phase 3 --all
|
||||
/gsd:review --phase 2 --gemini
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `/gsd:pr-branch`
|
||||
|
||||
Create a clean PR branch by filtering out `.planning/` commits.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `target branch` | No | Base branch (default: `main`) |
|
||||
|
||||
**Purpose:** Reviewers see only code changes, not GSD planning artifacts.
|
||||
|
||||
```bash
|
||||
/gsd:pr-branch # Filter against main
|
||||
/gsd:pr-branch develop # Filter against develop
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `/gsd:audit-uat`
|
||||
|
||||
Cross-phase audit of all outstanding UAT and verification items.
|
||||
|
||||
**Prerequisites:** At least one phase has been executed with UAT or verification
|
||||
**Produces:** Categorized audit report with human test plan
|
||||
|
||||
```bash
|
||||
/gsd:audit-uat
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Backlog & Thread Commands
|
||||
|
||||
### `/gsd:add-backlog`
|
||||
|
||||
Add an idea to the backlog parking lot using 999.x numbering.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `description` | **Yes** | Backlog item description |
|
||||
|
||||
**999.x numbering** keeps backlog items outside the active phase sequence. Phase directories are created immediately so `/gsd:discuss-phase` and `/gsd:plan-phase` work on them.
|
||||
|
||||
```bash
|
||||
/gsd:add-backlog "GraphQL API layer"
|
||||
/gsd:add-backlog "Mobile responsive redesign"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `/gsd:review-backlog`
|
||||
|
||||
Review and promote backlog items to active milestone.
|
||||
|
||||
**Actions per item:** Promote (move to active sequence), Keep (leave in backlog), Remove (delete).
|
||||
|
||||
```bash
|
||||
/gsd:review-backlog
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `/gsd:plant-seed`
|
||||
|
||||
Capture a forward-looking idea with trigger conditions — surfaces automatically at the right milestone.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `idea summary` | No | Seed description (prompted if omitted) |
|
||||
|
||||
Seeds solve context rot: instead of a one-liner in Deferred that nobody reads, a seed preserves the full WHY, WHEN to surface, and breadcrumbs to details.
|
||||
|
||||
**Produces:** `.planning/seeds/SEED-NNN-slug.md`
|
||||
**Consumed by:** `/gsd:new-milestone` (scans seeds and presents matches)
|
||||
|
||||
```bash
|
||||
/gsd:plant-seed "Add real-time collaboration when WebSocket infra is in place"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `/gsd:thread`
|
||||
|
||||
Manage persistent context threads for cross-session work.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| (none) | — | List all threads |
|
||||
| `name` | — | Resume existing thread by name |
|
||||
| `description` | — | Create new thread |
|
||||
|
||||
Threads are lightweight cross-session knowledge stores for work that spans multiple sessions but doesn't belong to any specific phase. Lighter weight than `/gsd:pause-work`.
|
||||
|
||||
```bash
|
||||
/gsd:thread # List all threads
|
||||
/gsd:thread fix-deploy-key-auth # Resume thread
|
||||
/gsd:thread "Investigate TCP timeout in pasta service" # Create new
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Community Commands
|
||||
|
||||
### `/gsd:join-discord`
|
||||
|
||||
Reference in New Issue
Block a user