agent-method 1.5.5 → 1.5.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/README.md +68 -40
  2. package/bin/wwa.js +35 -9
  3. package/docs/internal/doc-tokens.yaml +452 -0
  4. package/docs/internal/feature-registry.yaml +13 -1
  5. package/lib/cli/casestudy.js +691 -0
  6. package/lib/cli/check.js +1 -1
  7. package/lib/cli/close.js +446 -0
  8. package/lib/cli/completion.js +639 -0
  9. package/lib/cli/digest.js +66 -0
  10. package/lib/cli/docs.js +207 -0
  11. package/lib/cli/helpers.js +49 -2
  12. package/lib/cli/implement.js +159 -0
  13. package/lib/cli/init.js +25 -6
  14. package/lib/cli/plan.js +128 -0
  15. package/lib/cli/refine.js +4 -4
  16. package/lib/cli/review.js +68 -0
  17. package/lib/cli/scan.js +2 -2
  18. package/lib/cli/status.js +1 -1
  19. package/lib/cli/upgrade.js +8 -7
  20. package/lib/init.js +205 -23
  21. package/package.json +10 -3
  22. package/templates/README.md +70 -22
  23. package/templates/entry-points/.cursorrules +142 -13
  24. package/templates/entry-points/AGENT.md +142 -13
  25. package/templates/entry-points/CLAUDE.md +142 -13
  26. package/templates/extensions/analytical-system.md +1 -1
  27. package/templates/extensions/code-project.md +1 -1
  28. package/templates/extensions/data-exploration.md +1 -1
  29. package/templates/full/.context/BASE.md +33 -0
  30. package/templates/full/.context/METHODOLOGY.md +62 -5
  31. package/templates/full/.cursorrules +127 -17
  32. package/templates/full/AGENT.md +127 -17
  33. package/templates/full/CLAUDE.md +127 -17
  34. package/templates/full/Management/DIGEST.md +23 -0
  35. package/templates/full/Management/STATUS.md +46 -0
  36. package/templates/full/PROJECT.md +34 -0
  37. package/templates/full/Reviews/INDEX.md +41 -0
  38. package/templates/full/Reviews/backlog.md +52 -0
  39. package/templates/full/Reviews/plan.md +43 -0
  40. package/templates/full/Reviews/project.md +41 -0
  41. package/templates/full/Reviews/requirements.md +42 -0
  42. package/templates/full/Reviews/roadmap.md +41 -0
  43. package/templates/full/Reviews/state.md +56 -0
  44. package/templates/full/SUMMARY.md +7 -4
  45. package/templates/full/agentWorkflows/INDEX.md +42 -0
  46. package/templates/full/agentWorkflows/observations.md +65 -0
  47. package/templates/full/agentWorkflows/patterns.md +68 -0
  48. package/templates/full/agentWorkflows/sessions.md +92 -0
  49. package/templates/full/intro/README.md +39 -0
  50. package/templates/starter/.context/BASE.md +35 -0
  51. package/templates/starter/.context/METHODOLOGY.md +59 -5
  52. package/templates/starter/.cursorrules +134 -12
  53. package/templates/starter/AGENT.md +134 -12
  54. package/templates/starter/CLAUDE.md +134 -12
  55. package/templates/starter/Management/DIGEST.md +23 -0
  56. package/templates/starter/Management/STATUS.md +46 -0
  57. package/templates/starter/PROJECT.md +34 -0
  58. package/templates/starter/Reviews/INDEX.md +75 -0
  59. package/templates/starter/SUMMARY.md +27 -0
  60. package/templates/starter/agentWorkflows/INDEX.md +61 -0
  61. package/templates/starter/intro/README.md +37 -0
  62. package/templates/full/docs/index.md +0 -46
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # wwa
2
2
 
3
- A file-structure-first methodology for AI-agent-assisted development. Files are the interface — no proprietary tools, no vendor lock-in. Works with Claude Code, Cursor, or any agent that reads markdown.
3
+ A file-structure-first methodology for AI-agent-assisted development. Files are the interface — no proprietary tools, no vendor lock-in. Works with Claude Code, Cursor, Gemini, Codex, or any agent that reads markdown.
4
4
 
5
5
  `ai-agents` `prompt-engineering` `developer-tools` `context-engineering` `agent-framework` `mcp` `model-context-protocol` `cursor` `claude-code`
6
6
 
@@ -10,16 +10,16 @@ A file-structure-first methodology for AI-agent-assisted development. Files are
10
10
 
11
11
  There is real stigma around AI-assisted development, and it's warranted. Most "vibe coding" produces work that no one fully understands — not the developer, not the agent, and certainly not the next person who reads the code.
12
12
 
13
- This project takes a different position. Three active case studies are being run to examine how development agents reason, where they lose context, and what structures keep their output connected to human-readable, auditable decisions. The methodology tracks agent behavior session over session — what worked, what was revised, what the human had to correct — and feeds that data back into improving future collaboration.
13
+ This spec-drive development project takes a different position. Three active case studies are being run to examine how development agents reason, where they lose context, and what structures keep their output connected to human-readable, auditable decisions. The methodology tracks agent behavior session over session — what worked, what was revised, what the human had to correct — and feeds that data back into improving future collaboration.
14
14
 
15
- If you want to build with an agent but also want full visibility into the work being done, the decisions being made, and a path to measurably improving your agent's effectiveness over time — this is for you.
15
+ If you want to build with an agent but also want full visibility into the work being done, the decisions being made, and a path to measurably improving your agent's effectiveness over time.
16
16
 
17
17
  ---
18
18
 
19
19
  ## Requirements
20
20
 
21
21
  - **Node.js >= 18** — [download](https://nodejs.org/)
22
- - **A supported AI runtime** — [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [Cursor](https://cursor.sh), or any agent that reads markdown files
22
+ - **A supported AI runtime** — [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [Cursor](https://cursor.sh) / Composer, [Gemini](https://gemini.google.com), [Codex](https://openai.com/index/codex/), or any agent that reads markdown
23
23
 
24
24
  ---
25
25
 
@@ -27,18 +27,19 @@ If you want to build with an agent but also want full visibility into the work b
27
27
 
28
28
  ### Quick start (recommended)
29
29
 
30
- One command, guided prompts:
30
+ Install once, use everywhere:
31
31
 
32
32
  ```bash
33
- npx agent-method init
33
+ npm install -g agent-method
34
+ wwa init
34
35
  ```
35
36
 
36
37
  The installer walks you through everything:
37
38
 
38
39
  1. **Project type** — Code, Data, Analytical, Mixed, or General
39
40
  2. **Directory** — where to set up (default: current directory)
40
- 3. **Runtime** — Claude Code, Cursor, or all (creates the right entry point)
41
- 4. **Template tier** — Starter (7 files, most projects) or Full (11+ files, complex projects)
41
+ 3. **Runtime** — Claude Code, Cursor, or Other/All (Gemini, Codex, Composer, etc.)
42
+ 4. **Template tier** — Starter (17 files, most projects) or Full (30 files, complex projects)
42
43
  5. **Integration profile** — Standard (Sonnet, recommended), Lite (Haiku), or Full (Opus)
43
44
 
44
45
  Done. Open `PROJECT.md` and start working with your AI agent.
@@ -46,26 +47,18 @@ Done. Open `PROJECT.md` and start working with your AI agent.
46
47
  To update an existing project later:
47
48
 
48
49
  ```bash
49
- npx agent-method upgrade # adds new methodology sections, never overwrites
50
- npx agent-method status # check your current version
50
+ wwa upgrade # adds new methodology sections, never overwrites
51
+ wwa status # check your current version
51
52
  ```
52
53
 
53
54
  <details>
54
- <summary><strong>Install globally</strong> — skip <code>npx</code> each time</summary>
55
-
56
- ```bash
57
- npm install -g agent-method
58
- ```
59
-
60
- After this, use `wwa` directly:
55
+ <summary><strong>Zero-install</strong> — no global install needed</summary>
61
56
 
62
57
  ```bash
63
- wwa init
64
- wwa check
65
- wwa status
58
+ npx agent-method init
66
59
  ```
67
60
 
68
- Both `wwa` and `agent-method` work as command names.
61
+ Runs directly via npx without installing anything. Useful for one-time setup or CI.
69
62
 
70
63
  </details>
71
64
 
@@ -76,16 +69,16 @@ Specify everything on the command line (no prompts):
76
69
 
77
70
  ```bash
78
71
  # Full options
79
- npx agent-method init code ~/my-project --runtime claude --tier starter --profile standard
72
+ wwa init code ~/my-project --runtime claude --tier starter --profile standard
80
73
 
81
74
  # Just type and directory (defaults for the rest)
82
- npx agent-method init code ~/my-project
75
+ wwa init code ~/my-project
83
76
 
84
77
  # Data project for Cursor
85
- npx agent-method init data ~/my-data --runtime cursor
78
+ wwa init data ~/my-data --runtime cursor
86
79
 
87
80
  # Analytical project with full methodology
88
- npx agent-method init context ~/my-analysis --tier full --profile full
81
+ wwa init context ~/my-analysis --tier full --profile full
89
82
  ```
90
83
 
91
84
  **Options:**
@@ -95,6 +88,7 @@ npx agent-method init context ~/my-analysis --tier full --profile full
95
88
  | `--runtime` | `claude`, `cursor`, `all` | `all` |
96
89
  | `--tier` | `starter`, `full` | `starter` |
97
90
  | `--profile` | `lite`, `standard`, `full` | `standard` |
91
+ | `--onboarding` | `greenfield`, `brownfield`, `auto` | `auto` |
98
92
 
99
93
  </details>
100
94
 
@@ -136,7 +130,7 @@ Interactive — asks project name, type, runtime, tier, lifecycle, and profile.
136
130
  ## Verify
137
131
 
138
132
  ```bash
139
- npx agent-method check
133
+ wwa check
140
134
  ```
141
135
 
142
136
  Validates your entry point, auto-detects project type, and reports any issues.
@@ -146,13 +140,13 @@ Validates your entry point, auto-detects project type, and reports any issues.
146
140
  ## Staying Updated
147
141
 
148
142
  ```bash
149
- npx agent-method upgrade
143
+ wwa upgrade
150
144
  ```
151
145
 
152
146
  Brownfield-safe — appends new methodology sections without overwriting your customizations.
153
147
 
154
148
  ```bash
155
- npx agent-method status # check your current version
149
+ wwa status # check your current version
156
150
  ```
157
151
 
158
152
  ---
@@ -161,13 +155,21 @@ npx agent-method status # check your current version
161
155
 
162
156
  | Command | What it does |
163
157
  |---------|-------------|
164
- | `wwa init` | Set up a new project (interactive) |
158
+ | `wwa init` | Set up a new project (interactive — copies templates, feature registry, creates doc-tokens) |
165
159
  | `wwa check` | Validate your entry point |
166
160
  | `wwa scan` | Detect project type from directory contents |
167
161
  | `wwa route "<query>"` | Show how a query routes through the pipeline |
162
+ | `wwa plan` | Display current plan status from PLAN.md |
163
+ | `wwa implement` | Show implementation guidance for current step |
164
+ | `wwa review` | Display project review dashboard |
165
+ | `wwa digest` | Show management digest |
166
+ | `wwa close` | Session close checklist, project snapshot, updates .context/doc-tokens.yaml |
168
167
  | `wwa refine` | Extract refinement report from SESSION-LOG.md |
168
+ | `wwa casestudy` | Extract case study with project tokens + methodology reference data |
169
+ | `wwa docs` | Show docs coverage report from .context/DOCS-MAP.md |
169
170
  | `wwa status` | Check if your methodology version is current |
170
171
  | `wwa upgrade` | Brownfield-safe methodology update |
172
+ | `wwa completion` | Generate shell tab-completion (bash/zsh/fish/PowerShell) |
171
173
  | `wwa serve` | Start MCP server for IDE integration |
172
174
  | `wwa watch` | Watch files, validate on save |
173
175
 
@@ -182,8 +184,8 @@ Add to your IDE's MCP config (VS Code, Cursor, Claude Code, Cline):
182
184
  {
183
185
  "mcpServers": {
184
186
  "wwa": {
185
- "command": "npx",
186
- "args": ["agent-method", "serve"]
187
+ "command": "wwa",
188
+ "args": ["serve"]
187
189
  }
188
190
  }
189
191
  }
@@ -233,9 +235,22 @@ your-project/
233
235
  STATE.md # Decisions, blockers, current position
234
236
  ROADMAP.md # Phase breakdown with gate criteria
235
237
  PLAN.md # Current task with verification criteria
238
+ SUMMARY.md # Session audit trail
239
+ SESSION-LOG.md # Session metrics for case study data
236
240
  .context/
237
241
  BASE.md # Core context — always loaded with entry point
238
242
  METHODOLOGY.md # Workflows, conventions overflow
243
+ feature-registry.yaml # Feature registry (populated from package)
244
+ doc-tokens.yaml # Project metrics (updated by wwa close)
245
+ Management/
246
+ DIGEST.md # High-effort task digest for managers
247
+ STATUS.md # Project health snapshot
248
+ Reviews/
249
+ INDEX.md # Project intelligence dashboard
250
+ agentWorkflows/
251
+ INDEX.md # Agent workflow performance overview
252
+ intro/
253
+ README.md # Methodology overview + link to full docs
239
254
  ```
240
255
 
241
256
  <details>
@@ -243,18 +258,27 @@ your-project/
243
258
 
244
259
  ```
245
260
  REQUIREMENTS.md # Formal requirements with traceability
246
- SUMMARY.md # Session audit trail
247
261
  .context/
248
262
  REGISTRY.md # Navigation registry for large projects
249
- docs/
250
- index.md # Documentation hub
263
+ COMPOSITION.md # Specialist template for analytical projects
264
+ Reviews/
265
+ roadmap.md # Phase progress synthesis
266
+ plan.md # Plan execution history
267
+ project.md # Project scope evolution
268
+ requirements.md # Requirements traceability matrix
269
+ state.md # Decision trends and blocker analysis
270
+ backlog.md # Backlog health and aging
271
+ agentWorkflows/
272
+ sessions.md # Session analysis from SESSION-LOG.md
273
+ patterns.md # Extracted behavioral patterns
274
+ observations.md # Case study observations
251
275
  todos/
252
276
  backlog.md # Ideas and future work
253
277
  ```
254
278
 
255
279
  </details>
256
280
 
257
- Every file ships with **inline instructions** — the agent reads them and helps you populate each section.
281
+ Every file ships with **inline instructions** — the agent reads them and helps you populate each section. The agent also creates `.context/DOCS-MAP.md` during your first session to map project components to documentation files.
258
282
 
259
283
  ---
260
284
 
@@ -291,9 +315,9 @@ Existing solutions tie you to specific agent runtimes through CLI tools and slas
291
315
 
292
316
  | Profile | Best for | What's included |
293
317
  |---------|----------|-----------------|
294
- | **Lite** | Haiku, simple projects | STATE.md, minimal rules, 2 cascade rules |
295
- | **Standard** | Sonnet (recommended) | + PLAN.md, context pairing, 6 cascade rules |
296
- | **Full** | Opus, complex projects | All rules inline, all intelligence layer files |
318
+ | **Lite** | Haiku, GPT-3.5, Gemini Flash | STATE.md, minimal rules, 2 cascade rules |
319
+ | **Standard** | Sonnet, GPT-4, Gemini Pro, Codex (recommended) | + PLAN.md, context pairing, 6 cascade rules |
320
+ | **Full** | Opus, o1, Gemini Ultra | All rules inline, all intelligence layer files |
297
321
 
298
322
  Three rules followed consistently beat ten rules followed inconsistently.
299
323
 
@@ -328,8 +352,10 @@ Three rules followed consistently beat ten rules followed inconsistently.
328
352
  | File | Runtime | Auto-loaded? |
329
353
  |------|---------|:------------:|
330
354
  | `CLAUDE.md` | Claude Code | Yes |
331
- | `.cursorrules` | Cursor | Yes |
332
- | `AGENT.md` | Any agent | No (paste or reference manually) |
355
+ | `.cursorrules` | Cursor / Cursor Composer | Yes |
356
+ | `AGENT.md` | Gemini, Codex, Cline, Aider, or any agent that reads markdown | No (paste or reference manually) |
357
+
358
+ The methodology is **agent-agnostic**. `AGENT.md` works with any AI assistant — copy its contents into your tool's system prompt or context window. The file format is standard markdown; no runtime-specific features are required.
333
359
 
334
360
  </details>
335
361
 
@@ -341,6 +367,8 @@ Three rules followed consistently beat ten rules followed inconsistently.
341
367
  |----------|----------|
342
368
  | [Quick start guide](docs/guides/quick-start.md) | Setup and first session |
343
369
  | [For developers](docs/guides/for-developers.md) | Workflows, context, troubleshooting |
370
+ | [CLI tools reference](docs/guides/for-developers/cli-tools.md) | All 22 commands with examples |
371
+ | [Command reference](docs/guides/for-developers/command-reference.md) | Tabular quick-lookup by project type |
344
372
  | [MCP Integration](docs/guides/mcp-integration.md) | IDE integration (VS Code, Cursor, Claude Code, Cline) |
345
373
  | [For managers](docs/guides/for-managers.md) | Reading project status from methodology files |
346
374
  | [Template kit](templates/README.md) | Template tiers, extensions, bootstrapping |
package/bin/wwa.js CHANGED
@@ -6,7 +6,8 @@
6
6
  * Thin entry point: each command is registered from lib/cli/*.js modules.
7
7
  *
8
8
  * Three-tier command structure:
9
- * Tier 1 (developer): check, scan, route, refine, status, upgrade, init
9
+ * Tier 1 (developer): check, scan, route, refine, status, upgrade, init,
10
+ * plan, implement, review, digest, close
10
11
  * Tier 2 (pipeline): wwa pipeline classify/select/resolve/cascade/test
11
12
  * Tier 3 (server): serve (MCP server), watch (file watcher)
12
13
  */
@@ -21,9 +22,17 @@ import { register as refine } from "../lib/cli/refine.js";
21
22
  import { register as status } from "../lib/cli/status.js";
22
23
  import { register as upgrade } from "../lib/cli/upgrade.js";
23
24
  import { register as init } from "../lib/cli/init.js";
25
+ import { register as planCmd } from "../lib/cli/plan.js";
26
+ import { register as implementCmd } from "../lib/cli/implement.js";
27
+ import { register as reviewCmd } from "../lib/cli/review.js";
28
+ import { register as digestCmd } from "../lib/cli/digest.js";
29
+ import { register as closeCmd } from "../lib/cli/close.js";
24
30
  import { register as pipeline } from "../lib/cli/pipeline.js";
25
31
  import { register as serve } from "../lib/cli/serve.js";
26
32
  import { register as watchCmd } from "../lib/cli/watch.js";
33
+ import { register as completionCmd } from "../lib/cli/completion.js";
34
+ import { register as casestudyCmd } from "../lib/cli/casestudy.js";
35
+ import { register as docsCmd } from "../lib/cli/docs.js";
27
36
 
28
37
  const program = new Command();
29
38
 
@@ -32,13 +41,20 @@ program
32
41
  .description(
33
42
  "Methodology tools for AI-agent-assisted development.\n\n" +
34
43
  "Developer commands:\n" +
35
- " check Validate your entry point and project setup\n" +
36
- " scan Detect project type from directory contents\n" +
37
- " route Show how a query routes through the pipeline\n" +
38
- " refine Extract a refinement report from session history\n" +
39
- " status Check if your methodology version is current\n" +
40
- " upgrade Update your project to the latest methodology\n" +
41
- " init Set up a new project with methodology templates\n\n" +
44
+ " check Validate your entry point and project setup\n" +
45
+ " scan Detect project type from directory contents\n" +
46
+ " route Show how a query routes through the pipeline\n" +
47
+ " refine Extract a refinement report from session history\n" +
48
+ " status Check if your methodology version is current\n" +
49
+ " upgrade Update your project to the latest methodology\n" +
50
+ " init Set up a new project with methodology templates\n" +
51
+ " plan Display current plan status from PLAN.md\n" +
52
+ " implement Show implementation guidance for current step\n" +
53
+ " review Display project review dashboard\n" +
54
+ " digest Show management digest\n" +
55
+ " close Session close checklist and cascade reminders\n" +
56
+ " casestudy Extract structured case study from project files\n" +
57
+ " docs Show docs coverage report from DOCS-MAP.md\n\n" +
42
58
  "Pipeline commands (advanced):\n" +
43
59
  " pipeline classify Classify a query against registry patterns\n" +
44
60
  " pipeline select Select workflow for a query type\n" +
@@ -47,7 +63,9 @@ program
47
63
  " pipeline test Run YAML test fixtures\n\n" +
48
64
  "Server commands:\n" +
49
65
  " serve Start MCP server on stdio transport\n" +
50
- " watch Watch files and validate on change"
66
+ " watch Watch files and validate on change\n\n" +
67
+ "Shell completion:\n" +
68
+ " completion Generate tab-completion for bash/zsh/fish/powershell"
51
69
  )
52
70
  .version(pkg.version, "-V, --version");
53
71
 
@@ -59,8 +77,16 @@ refine(program);
59
77
  status(program);
60
78
  upgrade(program);
61
79
  init(program);
80
+ planCmd(program);
81
+ implementCmd(program);
82
+ reviewCmd(program);
83
+ digestCmd(program);
84
+ closeCmd(program);
62
85
  pipeline(program);
63
86
  serve(program);
64
87
  watchCmd(program);
88
+ completionCmd(program);
89
+ casestudyCmd(program);
90
+ docsCmd(program);
65
91
 
66
92
  program.parse();