agent-method 1.5.12
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.
- package/README.md +343 -0
- package/bin/wwa.js +115 -0
- package/docs/internal/cli-commands.yaml +259 -0
- package/docs/internal/doc-tokens.yaml +1103 -0
- package/docs/internal/feature-registry.yaml +1643 -0
- package/lib/boundaries.js +247 -0
- package/lib/cli/add.js +170 -0
- package/lib/cli/casestudy.js +1000 -0
- package/lib/cli/check.js +323 -0
- package/lib/cli/close.js +838 -0
- package/lib/cli/completion.js +735 -0
- package/lib/cli/deps.js +234 -0
- package/lib/cli/digest.js +73 -0
- package/lib/cli/doc-review.js +486 -0
- package/lib/cli/docs.js +315 -0
- package/lib/cli/helpers.js +198 -0
- package/lib/cli/implement.js +169 -0
- package/lib/cli/init.js +280 -0
- package/lib/cli/pipeline.js +206 -0
- package/lib/cli/plan.js +140 -0
- package/lib/cli/record.js +98 -0
- package/lib/cli/refine.js +202 -0
- package/lib/cli/report-helpers.js +113 -0
- package/lib/cli/review.js +76 -0
- package/lib/cli/routable.js +109 -0
- package/lib/cli/route.js +101 -0
- package/lib/cli/scan.js +133 -0
- package/lib/cli/serve.js +23 -0
- package/lib/cli/status.js +65 -0
- package/lib/cli/update-docs.js +574 -0
- package/lib/cli/upgrade.js +222 -0
- package/lib/cli/watch.js +32 -0
- package/lib/dependencies.js +196 -0
- package/lib/init.js +692 -0
- package/lib/mcp-server.js +612 -0
- package/lib/pipeline.js +907 -0
- package/lib/registry.js +132 -0
- package/lib/watcher.js +165 -0
- package/package.json +54 -0
- package/templates/README.md +363 -0
- package/templates/entry-points/.cursorrules +90 -0
- package/templates/entry-points/AGENT.md +90 -0
- package/templates/entry-points/CLAUDE.md +88 -0
- package/templates/extensions/MANIFEST.md +110 -0
- package/templates/extensions/analytical-system.md +96 -0
- package/templates/extensions/code-project.md +77 -0
- package/templates/extensions/data-exploration.md +117 -0
- package/templates/full/.context/BASE.md +101 -0
- package/templates/full/.context/COMPOSITION.md +47 -0
- package/templates/full/.context/INDEX.yaml +56 -0
- package/templates/full/.context/METHODOLOGY.md +246 -0
- package/templates/full/.context/PROTOCOL.yaml +169 -0
- package/templates/full/.context/REGISTRY.md +75 -0
- package/templates/full/.cursorrules +90 -0
- package/templates/full/AGENT.md +90 -0
- package/templates/full/CLAUDE.md +90 -0
- package/templates/full/Management/DIGEST.md +23 -0
- package/templates/full/Management/STATUS.md +46 -0
- package/templates/full/PLAN.md +67 -0
- package/templates/full/PROJECT-PROFILE.md +61 -0
- package/templates/full/PROJECT.md +80 -0
- package/templates/full/REQUIREMENTS.md +30 -0
- package/templates/full/ROADMAP.md +39 -0
- package/templates/full/Reviews/INDEX.md +41 -0
- package/templates/full/Reviews/backlog.md +52 -0
- package/templates/full/Reviews/plan.md +43 -0
- package/templates/full/Reviews/project.md +41 -0
- package/templates/full/Reviews/requirements.md +42 -0
- package/templates/full/Reviews/roadmap.md +41 -0
- package/templates/full/Reviews/state.md +56 -0
- package/templates/full/SESSION-LOG.md +102 -0
- package/templates/full/STATE.md +42 -0
- package/templates/full/SUMMARY.md +27 -0
- package/templates/full/agentWorkflows/INDEX.md +42 -0
- package/templates/full/agentWorkflows/observations.md +65 -0
- package/templates/full/agentWorkflows/patterns.md +68 -0
- package/templates/full/agentWorkflows/sessions.md +92 -0
- package/templates/full/intro/README.md +39 -0
- package/templates/full/registry/feature-registry.yaml +25 -0
- package/templates/full/registry/features/catalog.yaml +743 -0
- package/templates/full/registry/features/protocol.yaml +121 -0
- package/templates/full/registry/features/routing.yaml +358 -0
- package/templates/full/registry/features/workflows.yaml +404 -0
- package/templates/full/todos/backlog.md +19 -0
- package/templates/starter/.context/BASE.md +66 -0
- package/templates/starter/.context/INDEX.yaml +51 -0
- package/templates/starter/.context/METHODOLOGY.md +228 -0
- package/templates/starter/.context/PROTOCOL.yaml +165 -0
- package/templates/starter/.cursorrules +90 -0
- package/templates/starter/AGENT.md +90 -0
- package/templates/starter/CLAUDE.md +90 -0
- package/templates/starter/Management/DIGEST.md +23 -0
- package/templates/starter/Management/STATUS.md +46 -0
- package/templates/starter/PLAN.md +67 -0
- package/templates/starter/PROJECT-PROFILE.md +44 -0
- package/templates/starter/PROJECT.md +80 -0
- package/templates/starter/ROADMAP.md +39 -0
- package/templates/starter/Reviews/INDEX.md +75 -0
- package/templates/starter/SESSION-LOG.md +102 -0
- package/templates/starter/STATE.md +42 -0
- package/templates/starter/SUMMARY.md +27 -0
- package/templates/starter/agentWorkflows/INDEX.md +61 -0
- package/templates/starter/intro/README.md +37 -0
- package/templates/starter/registry/feature-registry.yaml +25 -0
- package/templates/starter/registry/features/catalog.yaml +743 -0
- package/templates/starter/registry/features/protocol.yaml +121 -0
- package/templates/starter/registry/features/routing.yaml +358 -0
- package/templates/starter/registry/features/workflows.yaml +404 -0
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
# Template Kit
|
|
2
|
+
|
|
3
|
+
Copyable project templates. Pick one, copy it into your project root, fill in PROJECT.md, and start working with your AI agent.
|
|
4
|
+
|
|
5
|
+
## Starter template (minimum viable)
|
|
6
|
+
|
|
7
|
+
For most projects. Gives you cross-session memory, scoped context loading, persistent codebase understanding, lifecycle tracking, structured execution, and management reporting.
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
starter/
|
|
11
|
+
CLAUDE.md # Claude Code entry point (auto-loaded)
|
|
12
|
+
.cursorrules # Cursor entry point (auto-loaded)
|
|
13
|
+
AGENT.md # Generic entry point (manual loading)
|
|
14
|
+
PROJECT.md # Your project vision -- fill this in first
|
|
15
|
+
PROJECT-PROFILE.md # Project type, lifecycle stage, active extensions (agent-maintained)
|
|
16
|
+
STATE.md # Decisions, blockers, current position
|
|
17
|
+
ROADMAP.md # Phase breakdown with gate criteria
|
|
18
|
+
PLAN.md # Current task with verification criteria
|
|
19
|
+
SUMMARY.md # Session audit trail
|
|
20
|
+
SESSION-LOG.md # Session metrics for case study data
|
|
21
|
+
.context/
|
|
22
|
+
BASE.md # Core context -- always loaded with entry point
|
|
23
|
+
PROTOCOL.yaml # Agent protocol -- scoping, cascade, conventions, close-check
|
|
24
|
+
INDEX.yaml # Navigation manifest -- file inventory, project metadata, metrics
|
|
25
|
+
METHODOLOGY.md # Onboarding protocol and format specs (loaded on-demand)
|
|
26
|
+
registry/
|
|
27
|
+
feature-registry.yaml # Feature registry index (layers → features/)
|
|
28
|
+
features/
|
|
29
|
+
catalog.yaml # Domains + features
|
|
30
|
+
workflows.yaml # Guided workflows
|
|
31
|
+
protocol.yaml # Agent behavioral protocol directives
|
|
32
|
+
routing.yaml # Query patterns + activation rules
|
|
33
|
+
doc-tokens.yaml # Project metrics, doc dependency graph, terminology (created at init, updated by wwa close)
|
|
34
|
+
Management/
|
|
35
|
+
DIGEST.md # High-effort task digest for managers
|
|
36
|
+
STATUS.md # Project health snapshot
|
|
37
|
+
Reviews/
|
|
38
|
+
INDEX.md # Synthesized project intelligence dashboard
|
|
39
|
+
agentWorkflows/
|
|
40
|
+
INDEX.md # Agent workflow performance overview
|
|
41
|
+
intro/
|
|
42
|
+
README.md # Methodology overview + link to full docs
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Setup**: Delete the two entry point files you don't use. Keep the one that matches your agent runtime.
|
|
46
|
+
|
|
47
|
+
**What you get**: Persistent decisions, scoped file reading, phase-gated execution, atomic task tracking, configurable interaction level, persistent codebase context, management digest, project reviews, workflow analysis, docs dependency mapping, document dependency graph with terminology capture, configurable project boundaries (visibility, distribution, path resolution via PROTOCOL.yaml).
|
|
48
|
+
|
|
49
|
+
**docs/ is for your project**: The `docs/` folder is not pre-created — the agent creates `.context/DOCS-MAP.md` during first-session onboarding and proposes docs/ files as your project grows based on its scaffolding rules.
|
|
50
|
+
|
|
51
|
+
**What you don't get**: Specialist context pairing, full review drill-downs, full workflow analysis files.
|
|
52
|
+
|
|
53
|
+
## Full template (complete methodology)
|
|
54
|
+
|
|
55
|
+
For complex or multi-phase projects where context management and dual-audience separation matter.
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
full/
|
|
59
|
+
CLAUDE.md # Claude Code entry point (auto-loaded)
|
|
60
|
+
.cursorrules # Cursor entry point (auto-loaded)
|
|
61
|
+
AGENT.md # Generic entry point (manual loading)
|
|
62
|
+
PROJECT.md # Vision, audiences, structure
|
|
63
|
+
PROJECT-PROFILE.md # Project type, lifecycle, extensions (agent-maintained)
|
|
64
|
+
STATE.md # Decisions, blockers, position, open questions
|
|
65
|
+
REQUIREMENTS.md # Scoped features with phase traceability
|
|
66
|
+
ROADMAP.md # Phase breakdown with gate criteria
|
|
67
|
+
PLAN.md # Current atomic task
|
|
68
|
+
SUMMARY.md # Session audit trail
|
|
69
|
+
SESSION-LOG.md # Session metrics for case study data
|
|
70
|
+
.context/
|
|
71
|
+
BASE.md # Core context -- always loaded with entry point
|
|
72
|
+
PROTOCOL.yaml # Agent protocol -- scoping, cascade, conventions, close-check
|
|
73
|
+
INDEX.yaml # Navigation manifest -- file inventory, project metadata, metrics
|
|
74
|
+
METHODOLOGY.md # Onboarding protocol and format specs (loaded on-demand)
|
|
75
|
+
REGISTRY.md # Navigation registry for split file trees
|
|
76
|
+
COMPOSITION.md # Specialist template for analytical projects
|
|
77
|
+
registry/
|
|
78
|
+
feature-registry.yaml # Feature registry index (layers → features/)
|
|
79
|
+
features/
|
|
80
|
+
catalog.yaml # Domains + features
|
|
81
|
+
workflows.yaml # Guided workflows
|
|
82
|
+
protocol.yaml # Agent behavioral protocol directives
|
|
83
|
+
routing.yaml # Query patterns + activation rules
|
|
84
|
+
doc-tokens.yaml # Project metrics, doc dependency graph, terminology (created at init, updated by wwa close)
|
|
85
|
+
Management/
|
|
86
|
+
DIGEST.md # High-effort task digest for managers
|
|
87
|
+
STATUS.md # Project health snapshot
|
|
88
|
+
Reviews/
|
|
89
|
+
INDEX.md # Synthesized project intelligence dashboard
|
|
90
|
+
roadmap.md # Phase progress synthesis
|
|
91
|
+
plan.md # Plan execution history
|
|
92
|
+
project.md # Project scope evolution
|
|
93
|
+
requirements.md # Requirements traceability matrix
|
|
94
|
+
state.md # Decision trends and blocker analysis
|
|
95
|
+
backlog.md # Backlog health and aging
|
|
96
|
+
agentWorkflows/
|
|
97
|
+
INDEX.md # Agent workflow performance overview
|
|
98
|
+
sessions.md # Session analysis from SESSION-LOG.md
|
|
99
|
+
patterns.md # Extracted behavioral patterns
|
|
100
|
+
observations.md # Case study observations
|
|
101
|
+
intro/
|
|
102
|
+
README.md # Methodology overview + link to full docs
|
|
103
|
+
todos/
|
|
104
|
+
backlog.md # Captured ideas for future work
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
**Setup**: Delete the two entry point files you don't use. Keep the one that matches your agent runtime.
|
|
108
|
+
|
|
109
|
+
**What you get**: Everything in starter, plus specialist context pairing, dependency cascade, execution history, human dashboard scaffold, backlog capture, full review drill-downs, full workflow analysis, full communication point structure (direction, checkpoint, record).
|
|
110
|
+
|
|
111
|
+
## Template content: guided, not empty
|
|
112
|
+
|
|
113
|
+
Template files ship with **inline instructions** — structured prompts that show both the user and the agent what goes in each section. The agent can read these instructions and help populate the files.
|
|
114
|
+
|
|
115
|
+
Example from a guided PROJECT.md:
|
|
116
|
+
```markdown
|
|
117
|
+
# {Your Project Name}
|
|
118
|
+
|
|
119
|
+
<!-- INSTRUCTION: Replace with a 2-3 sentence description of your project -->
|
|
120
|
+
{Describe what your project does and who it's for}
|
|
121
|
+
|
|
122
|
+
## Problem
|
|
123
|
+
<!-- INSTRUCTION: What problem does this solve? 2-3 bullet points. -->
|
|
124
|
+
|
|
125
|
+
## Solution
|
|
126
|
+
<!-- INSTRUCTION: How does the project solve the problem? -->
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Example from a guided .context/BASE.md:
|
|
130
|
+
```markdown
|
|
131
|
+
# Base Context — Always Loaded
|
|
132
|
+
|
|
133
|
+
## What this system is
|
|
134
|
+
<!-- INSTRUCTION: 2-3 sentences describing your project's architecture -->
|
|
135
|
+
|
|
136
|
+
## Codebase map
|
|
137
|
+
<!-- INSTRUCTION: Table of directories, their purposes, and key patterns -->
|
|
138
|
+
<!-- The agent will help populate this from a codebase scan -->
|
|
139
|
+
| Path | Purpose | Key patterns |
|
|
140
|
+
|------|---------|-------------|
|
|
141
|
+
|
|
142
|
+
## Pairing protocol
|
|
143
|
+
| Task type | Pair BASE.md with |
|
|
144
|
+
|-----------|-------------------|
|
|
145
|
+
<!-- INSTRUCTION: Add rows as you create specialist .context/ files -->
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
The inline instructions serve as:
|
|
149
|
+
- **User guidance**: Human sees what to fill in
|
|
150
|
+
- **Agent prompts**: Agent reads the instructions and can help populate
|
|
151
|
+
- **Structure enforcement**: Files have the right sections from day one
|
|
152
|
+
|
|
153
|
+
## Bootstrapping: new project vs existing codebase
|
|
154
|
+
|
|
155
|
+
### Greenfield (starting from scratch)
|
|
156
|
+
|
|
157
|
+
1. Copy template into your project root
|
|
158
|
+
2. Delete the two entry point files you don't use
|
|
159
|
+
3. Fill in PROJECT.md with your project vision
|
|
160
|
+
4. Start a conversation — the agent helps populate .context/BASE.md as you build
|
|
161
|
+
|
|
162
|
+
### Brownfield (existing codebase)
|
|
163
|
+
|
|
164
|
+
1. Copy template into your existing project root
|
|
165
|
+
2. Delete the two entry point files you don't use
|
|
166
|
+
3. Fill in PROJECT.md with your project vision
|
|
167
|
+
4. Ask the agent: "Scan the codebase and populate the context files"
|
|
168
|
+
5. Agent activates the **Discovery workflow (WF-08)**:
|
|
169
|
+
- **Inventory**: Walks entire project structure, maps directories and files
|
|
170
|
+
- **Map**: Traces dependencies (packages, imports, services)
|
|
171
|
+
- **Extract**: Identifies patterns, conventions, and architectural decisions
|
|
172
|
+
- **Assess**: Evaluates technical debt, risks, and improvement opportunities
|
|
173
|
+
- **Bootstrap**: Writes .context/BASE.md, proposes specialists, updates scoping table
|
|
174
|
+
6. Agent updates PROJECT-PROFILE.md lifecycle stage to "discovery"
|
|
175
|
+
7. You approve specialist files; agent transitions lifecycle to "development" when ready
|
|
176
|
+
|
|
177
|
+
### Integration profiles
|
|
178
|
+
|
|
179
|
+
Both templates support three integration profiles that control how much methodology surface area gets installed. This is critical for brownfield projects and lighter models.
|
|
180
|
+
|
|
181
|
+
| Profile | Target model | What's installed | Entry point budget |
|
|
182
|
+
|---------|-------------|-----------------|-------------------|
|
|
183
|
+
| **Lite** | Haiku, GPT-3.5 | STATE.md + .context/METHODOLOGY.md | 25 lines |
|
|
184
|
+
| **Standard** | Sonnet, GPT-4 | STATE.md, PLAN.md, .context/BASE.md, .context/METHODOLOGY.md | 40 lines |
|
|
185
|
+
| **Full** | Opus, o1 | All intelligence layer files | 60 lines |
|
|
186
|
+
|
|
187
|
+
For lite and standard profiles, operational details (workflows, extended conventions, do-not rules) overflow to `.context/METHODOLOGY.md` — loaded on-demand via the scoping table, not every session. This keeps the entry point lean enough for lighter models to process reliably.
|
|
188
|
+
|
|
189
|
+
When setup.sh detects an existing entry point file, it uses the **brownfield merge protocol**: methodology content is appended to the existing file rather than overwriting it.
|
|
190
|
+
|
|
191
|
+
See `docs/architecture/integration-profiles.md` for the full specification.
|
|
192
|
+
|
|
193
|
+
### Interaction level (in entry point)
|
|
194
|
+
|
|
195
|
+
Both templates include an interaction level setting in the entry point:
|
|
196
|
+
|
|
197
|
+
```markdown
|
|
198
|
+
## Interaction level
|
|
199
|
+
mode: checkpoint # autonomous | checkpoint | collaborative | supervised
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
| Level | Agent behavior |
|
|
203
|
+
|-------|---------------|
|
|
204
|
+
| **autonomous** | Executes full plan, reports at completion |
|
|
205
|
+
| **checkpoint** | Proposes plan, executes after approval, reports at completion |
|
|
206
|
+
| **collaborative** | Back-and-forth at each step |
|
|
207
|
+
| **supervised** | Explains intent before every file change |
|
|
208
|
+
|
|
209
|
+
## Entry points (all three included)
|
|
210
|
+
|
|
211
|
+
Both templates ship with all three entry point variants. Pick the one that matches your runtime and delete the others:
|
|
212
|
+
|
|
213
|
+
| File | Runtime | Auto-loaded? |
|
|
214
|
+
|------|---------|:------------:|
|
|
215
|
+
| `CLAUDE.md` | Claude Code | Yes |
|
|
216
|
+
| `.cursorrules` | Cursor | Yes |
|
|
217
|
+
| `AGENT.md` | Any agent (manual loading) | No |
|
|
218
|
+
|
|
219
|
+
All three contain identical scoping rules, cascade structure, and conventions — only the filename and auto-loading behavior differ.
|
|
220
|
+
|
|
221
|
+
Standalone entry point files are also available in `entry-points/` for reference or individual use.
|
|
222
|
+
|
|
223
|
+
## Project-type extensions
|
|
224
|
+
|
|
225
|
+
The starter and full templates ship with **universal** scoping rules, cascade rules, and workflows that work for any project. For project-type-specific capabilities, apply an extension.
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
extensions/
|
|
229
|
+
MANIFEST.md # Extension composition rules, compatibility matrix
|
|
230
|
+
code-project.md # Code-specific: scoping, cascade, WF-02, specialists
|
|
231
|
+
data-exploration.md # Data-specific: exploration commands, WF-05, specialists
|
|
232
|
+
analytical-system.md # Analytical-specific: chain work, evaluation, WF-06, specialists
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### How to apply an extension
|
|
236
|
+
|
|
237
|
+
1. Open the extension file (e.g., `extensions/code-project.md`)
|
|
238
|
+
2. Copy each section's rows into the corresponding section of your entry point
|
|
239
|
+
3. Create the recommended specialist .context/ files as your project grows
|
|
240
|
+
4. Delete the extension file — it's a reference, not a runtime artifact
|
|
241
|
+
|
|
242
|
+
### Extensions are additive
|
|
243
|
+
|
|
244
|
+
Extensions add rows to existing tables — they never override universal content. You can apply multiple extensions for projects that span types:
|
|
245
|
+
|
|
246
|
+
```
|
|
247
|
+
Base entry point (universal)
|
|
248
|
+
+ code-project.md (code scoping, cascade, WF-02)
|
|
249
|
+
+ data-exploration.md (exploration scoping, cascade, WF-05)
|
|
250
|
+
+ analytical-system.md (chain/evaluation scoping, cascade, WF-06)
|
|
251
|
+
= Mixed project entry point (any combination)
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### Registry-driven derivation
|
|
255
|
+
|
|
256
|
+
Extensions are derived from the feature registry (`docs/internal/feature-registry.yaml`). Each extension's scoping rules trace to registry `query_patterns`, cascade rules trace to registry `dependencies`, and workflows trace to registry `workflows`. See `docs/internal/entry-point-derivation.md` for the derivation specification.
|
|
257
|
+
|
|
258
|
+
## What the entry point embeds
|
|
259
|
+
|
|
260
|
+
The entry point is a thin boot loader (~50 lines) that directs the agent to structured YAML files:
|
|
261
|
+
|
|
262
|
+
- **Boot sequence** — 5-step "On every query" that loads STATE.md and `.context/PROTOCOL.yaml`
|
|
263
|
+
- **Settings** — Mode (interaction level), tier (standard/full), and method version
|
|
264
|
+
- **CLI tools** — Reference table of `wwa` commands (low cognitive load)
|
|
265
|
+
- **Do-not rules** — Negative constraints (highest ROI in auto-loaded file)
|
|
266
|
+
- **Close sentinel** — "Before ending this response" block exploiting LLM recency bias
|
|
267
|
+
|
|
268
|
+
The agent protocol (scoping rules, cascade triggers, conventions, close-check obligations) lives in `.context/PROTOCOL.yaml` — structured YAML that is denser, single-purpose, and machine-parseable. The navigation manifest (`.context/INDEX.yaml`) provides a file inventory with roles so agents know what exists without scanning.
|
|
269
|
+
|
|
270
|
+
An agent reading the entry point + PROTOCOL.yaml can follow the full behavioral protocol without accessing any other methodology documentation.
|
|
271
|
+
|
|
272
|
+
## Context maintenance
|
|
273
|
+
|
|
274
|
+
Context files are living documents. As your project evolves, the agent keeps them current:
|
|
275
|
+
|
|
276
|
+
- **Code changes** → Agent updates .context/BASE.md codebase map via cascade
|
|
277
|
+
- **New domain areas** → Agent suggests creating specialist .context/ files
|
|
278
|
+
- **Architecture decisions** → Agent records them in relevant .context/ files
|
|
279
|
+
- **Context drift** → Ask the agent "refresh the project context" to resync
|
|
280
|
+
|
|
281
|
+
See `docs/architecture/context-pairing.md` for the full context maintenance lifecycle.
|
|
282
|
+
|
|
283
|
+
## How to use
|
|
284
|
+
|
|
285
|
+
### Recommended: npx
|
|
286
|
+
|
|
287
|
+
```bash
|
|
288
|
+
npx agent-method init code ~/my-project
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
Replace `code` with: `context`, `data`, `mix`, or `general`.
|
|
292
|
+
|
|
293
|
+
### Manual
|
|
294
|
+
|
|
295
|
+
1. Copy `starter/` or `full/` into your project root
|
|
296
|
+
2. Delete the two entry point files you don't use
|
|
297
|
+
3. Fill in `PROJECT.md` with your project vision
|
|
298
|
+
4. Start a conversation with your agent — it reads the entry point and knows what to do
|
|
299
|
+
5. For existing codebases: ask the agent to scan and populate context files
|
|
300
|
+
|
|
301
|
+
See `docs/guides/quick-start.md` for a detailed walkthrough.
|
|
302
|
+
|
|
303
|
+
## CLI Tools (optional)
|
|
304
|
+
|
|
305
|
+
The methodology works without any tooling. For teams that want additional validation and automation:
|
|
306
|
+
|
|
307
|
+
```bash
|
|
308
|
+
npx agent-method # zero-install (Node.js 18+)
|
|
309
|
+
npm install -g agent-method # permanent install
|
|
310
|
+
pip install wwa-tools # Python alternative
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
### Developer commands
|
|
314
|
+
|
|
315
|
+
| Command | Use case |
|
|
316
|
+
|---------|----------|
|
|
317
|
+
| `wwa check` | Validate entry point (auto-finds CLAUDE.md/.cursorrules/AGENT.md) |
|
|
318
|
+
| `wwa scan` | Detect project type from directory contents |
|
|
319
|
+
| `wwa project-discovery` / `wwa context-refresh` / `wwa plan-create` | Test how discovery, refresh, or planning queries route through the pipeline |
|
|
320
|
+
| `wwa plan` | Display current plan status from PLAN.md |
|
|
321
|
+
| `wwa implement` | Show implementation guidance for current step |
|
|
322
|
+
| `wwa review` | Display project review dashboard |
|
|
323
|
+
| `wwa digest` | Show management digest |
|
|
324
|
+
| `wwa close` | Session close checklist, project snapshot, updates registry/doc-tokens.yaml |
|
|
325
|
+
| `wwa refine` | Extract refinement report (auto-finds SESSION-LOG.md) |
|
|
326
|
+
| `wwa casestudy` | Extract case study with project tokens + methodology reference data |
|
|
327
|
+
| `wwa docs` | Show docs coverage report from DOCS-MAP.md |
|
|
328
|
+
| `wwa status` | Check if methodology version is current |
|
|
329
|
+
| `wwa upgrade` | Brownfield-safe update (adds missing files, updates version) |
|
|
330
|
+
| `wwa init <type>` | Set up a new project |
|
|
331
|
+
| `wwa completion` | Generate shell tab-completion (bash/zsh/fish/PowerShell) |
|
|
332
|
+
|
|
333
|
+
**Safety invariant**: The CLI tool never modifies user source code. Only `.md` and `.yaml`/`.yml` files are writable.
|
|
334
|
+
|
|
335
|
+
### Project types
|
|
336
|
+
|
|
337
|
+
Use friendly names everywhere — all commands accept aliases:
|
|
338
|
+
|
|
339
|
+
```bash
|
|
340
|
+
wwa init code # software project
|
|
341
|
+
wwa init context # analytical/prompt project (e.g. PromptStudy)
|
|
342
|
+
wwa init data # data index/querying project (e.g. SysMLv2)
|
|
343
|
+
wwa init mix # multi-type project
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Advanced: pipeline subcommands
|
|
347
|
+
|
|
348
|
+
For internal debugging of routing logic, the CLI exposes `wwa pipeline classify|select|resolve|cascade|test`. These are intended for tool development and are not needed in normal project workflows.
|
|
349
|
+
|
|
350
|
+
### Dependencies
|
|
351
|
+
|
|
352
|
+
**Node.js (npx / npm)**:
|
|
353
|
+
- Node.js 18+
|
|
354
|
+
- commander ^12.0, js-yaml ^4.1, inquirer ^9.0, chalk ^5.0
|
|
355
|
+
|
|
356
|
+
**Python (pip)**:
|
|
357
|
+
- Python 3.9+
|
|
358
|
+
- PyYAML >= 6.0, Click >= 8.0
|
|
359
|
+
|
|
360
|
+
### Future enhancements
|
|
361
|
+
|
|
362
|
+
- MCP server: `pip install wwa-tools[mcp]` — exposes pipeline as agent-callable tools
|
|
363
|
+
- Registry watcher: `pip install wwa-tools[watch]` — proactive validation on file changes
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# {Project Name} — Agent Entry Point
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Replace {Project Name} and write a 1-2 sentence project description below -->
|
|
4
|
+
{Describe what your project does, its architecture, and key technologies.}
|
|
5
|
+
|
|
6
|
+
## On every query
|
|
7
|
+
|
|
8
|
+
1. This file is auto-loaded — read it first
|
|
9
|
+
2. Read `STATE.md` for current position, decisions, blockers
|
|
10
|
+
3. Read `.context/PROTOCOL.yaml` for scoping, cascade, and conventions
|
|
11
|
+
4. Scope query against PROTOCOL.yaml `scoping:` section
|
|
12
|
+
5. After work, check PROTOCOL.yaml `close_check` before ending response
|
|
13
|
+
|
|
14
|
+
## Settings
|
|
15
|
+
|
|
16
|
+
mode: checkpoint
|
|
17
|
+
<!-- autonomous | checkpoint | collaborative | supervised -->
|
|
18
|
+
<!-- checkpoint: propose plan, wait for approval, report at completion (default) -->
|
|
19
|
+
|
|
20
|
+
tier: full
|
|
21
|
+
<!-- lite | standard | full -->
|
|
22
|
+
<!-- lite: minimal rules, STATE.md only — for Haiku or simple projects -->
|
|
23
|
+
<!-- standard: core rules + context pairing — for Sonnet (default) -->
|
|
24
|
+
<!-- full: all rules, all intelligence layer files — for Opus or complex projects -->
|
|
25
|
+
|
|
26
|
+
method_version: 1.6
|
|
27
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
28
|
+
|
|
29
|
+
## CLI tools (optional)
|
|
30
|
+
|
|
31
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
32
|
+
|
|
33
|
+
| When you want to... | Run |
|
|
34
|
+
|---------------------|-----|
|
|
35
|
+
| Validate this entry point | `wwa check` |
|
|
36
|
+
| See what type of project this is | `wwa scan` |
|
|
37
|
+
| Test how a query routes | `wwa route "your question"` |
|
|
38
|
+
| See current plan status | `wwa plan` |
|
|
39
|
+
| Get implementation guidance | `wwa implement` |
|
|
40
|
+
| View project review dashboard | `wwa review` |
|
|
41
|
+
| Show management digest | `wwa digest` |
|
|
42
|
+
| Session close + project snapshot | `wwa close` |
|
|
43
|
+
| Extract a refinement report | `wwa refine` |
|
|
44
|
+
| Extract a case study (with project tokens) | `wwa casestudy` |
|
|
45
|
+
| Check docs coverage | `wwa docs` |
|
|
46
|
+
| Show dependency graph | `wwa deps` |
|
|
47
|
+
| Generate document registry | `wwa doc-review` |
|
|
48
|
+
| Check methodology version | `wwa status` |
|
|
49
|
+
| Update methodology files | `wwa upgrade` |
|
|
50
|
+
| Set up a new project | `wwa init` |
|
|
51
|
+
| Run project discovery workflow | `wwa project-discovery` |
|
|
52
|
+
| Run context refresh workflow | `wwa context-refresh` |
|
|
53
|
+
| Run phase completion workflow | `wwa phase-complete` |
|
|
54
|
+
| Show routing for backlog | `wwa backlog` |
|
|
55
|
+
| Run planning workflow | `wwa plan-create` |
|
|
56
|
+
| Run dependency analysis workflow | `wwa dependency-analysis` |
|
|
57
|
+
| Run debt assessment workflow | `wwa debt-assessment` |
|
|
58
|
+
| Run docs update workflow | `wwa docs-update` |
|
|
59
|
+
| Run cross-reference workflow | `wwa cross-reference` |
|
|
60
|
+
| Append to backlog / decision / finding / session / summary | `wwa add <type> [content]` |
|
|
61
|
+
|
|
62
|
+
When doing **project review** or **self-review** sessions, use the collection checklist for capture format: `docs/internal/review/collection-checklist.md` (if present).
|
|
63
|
+
|
|
64
|
+
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
65
|
+
project setup, or methodology updates. All commands auto-detect project type and find
|
|
66
|
+
entry points automatically. Add --json for machine-readable output. -->
|
|
67
|
+
|
|
68
|
+
## Do not
|
|
69
|
+
|
|
70
|
+
- Modify project source code, tests, or pre-existing documentation through methodology operations — only create/modify methodology files (STATE.md, .context/, PLAN.md, etc.)
|
|
71
|
+
- Delete existing project files during brownfield integration — methodology is additive only
|
|
72
|
+
- Load files not in PROTOCOL.yaml scoping read-set for the current query type
|
|
73
|
+
- Defer STATE.md decision recording to end of session
|
|
74
|
+
- Skip cascade checks after file changes
|
|
75
|
+
- Load multiple specialist .context/ files for a single query
|
|
76
|
+
- Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
|
|
77
|
+
|
|
78
|
+
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|
|
79
|
+
|
|
80
|
+
## First session
|
|
81
|
+
|
|
82
|
+
<!-- AGENT: If PROJECT.md contains {placeholder} text, this is a first session. -->
|
|
83
|
+
Follow the onboarding protocol in `.context/METHODOLOGY.md` — it guides you through
|
|
84
|
+
greenfield (4 stages) or brownfield (5 stages) setup with checkpoints at each step.
|
|
85
|
+
|
|
86
|
+
## Before ending this response
|
|
87
|
+
|
|
88
|
+
Read `.context/PROTOCOL.yaml` `close_check`. For each triggered item,
|
|
89
|
+
update the target file now. A response that modifies files but skips
|
|
90
|
+
triggered obligations is incomplete.
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# {Project Name} — Agent Entry Point
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Replace {Project Name} and write a 1-2 sentence project description below -->
|
|
4
|
+
{Describe what your project does, its architecture, and key technologies.}
|
|
5
|
+
|
|
6
|
+
## On every query
|
|
7
|
+
|
|
8
|
+
1. This file is auto-loaded — read it first
|
|
9
|
+
2. Read `STATE.md` for current position, decisions, blockers
|
|
10
|
+
3. Read `.context/PROTOCOL.yaml` for scoping, cascade, and conventions
|
|
11
|
+
4. Scope query against PROTOCOL.yaml `scoping:` section
|
|
12
|
+
5. After work, check PROTOCOL.yaml `close_check` before ending response
|
|
13
|
+
|
|
14
|
+
## Settings
|
|
15
|
+
|
|
16
|
+
mode: checkpoint
|
|
17
|
+
<!-- autonomous | checkpoint | collaborative | supervised -->
|
|
18
|
+
<!-- checkpoint: propose plan, wait for approval, report at completion (default) -->
|
|
19
|
+
|
|
20
|
+
tier: full
|
|
21
|
+
<!-- lite | standard | full -->
|
|
22
|
+
<!-- lite: minimal rules, STATE.md only — for Haiku or simple projects -->
|
|
23
|
+
<!-- standard: core rules + context pairing — for Sonnet (default) -->
|
|
24
|
+
<!-- full: all rules, all intelligence layer files — for Opus or complex projects -->
|
|
25
|
+
|
|
26
|
+
method_version: 1.6
|
|
27
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
28
|
+
|
|
29
|
+
## CLI tools (optional)
|
|
30
|
+
|
|
31
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
32
|
+
|
|
33
|
+
| When you want to... | Run |
|
|
34
|
+
|---------------------|-----|
|
|
35
|
+
| Validate this entry point | `wwa check` |
|
|
36
|
+
| See what type of project this is | `wwa scan` |
|
|
37
|
+
| Test how a query routes | `wwa project-discovery` / `wwa context-refresh` / `wwa plan-create` (see CLI docs) |
|
|
38
|
+
| See current plan status | `wwa plan` |
|
|
39
|
+
| Get implementation guidance | `wwa implement` |
|
|
40
|
+
| View project review dashboard | `wwa review` |
|
|
41
|
+
| Show management digest | `wwa digest` |
|
|
42
|
+
| Session close + project snapshot | `wwa close` |
|
|
43
|
+
| Extract a refinement report | `wwa refine` |
|
|
44
|
+
| Extract a case study (with project tokens) | `wwa casestudy` |
|
|
45
|
+
| Check docs coverage | `wwa docs` |
|
|
46
|
+
| Show dependency graph | `wwa deps` |
|
|
47
|
+
| Generate document registry | `wwa doc-review` |
|
|
48
|
+
| Check methodology version | `wwa status` |
|
|
49
|
+
| Update methodology files | `wwa upgrade` |
|
|
50
|
+
| Set up a new project | `wwa init` |
|
|
51
|
+
| Run project discovery workflow | `wwa project-discovery` |
|
|
52
|
+
| Run context refresh workflow | `wwa context-refresh` |
|
|
53
|
+
| Run phase completion workflow | `wwa phase-complete` |
|
|
54
|
+
| Show routing for backlog | `wwa backlog` |
|
|
55
|
+
| Run planning workflow | `wwa plan-create` |
|
|
56
|
+
| Run dependency analysis workflow | `wwa dependency-analysis` |
|
|
57
|
+
| Run debt assessment workflow | `wwa debt-assessment` |
|
|
58
|
+
| Run docs update workflow | `wwa docs-update` |
|
|
59
|
+
| Run cross-reference workflow | `wwa cross-reference` |
|
|
60
|
+
| Append to backlog / decision / finding / session / summary | `wwa add <type> [content]` |
|
|
61
|
+
|
|
62
|
+
When doing **project review** or **self-review** sessions, use the collection checklist for capture format: `docs/internal/review/collection-checklist.md` (if present).
|
|
63
|
+
|
|
64
|
+
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
65
|
+
project setup, or methodology updates. All commands auto-detect project type and find
|
|
66
|
+
entry points automatically. Add --json for machine-readable output. -->
|
|
67
|
+
|
|
68
|
+
## Do not
|
|
69
|
+
|
|
70
|
+
- Modify project source code, tests, or pre-existing documentation through methodology operations — only create/modify methodology files (STATE.md, .context/, PLAN.md, etc.)
|
|
71
|
+
- Delete existing project files during brownfield integration — methodology is additive only
|
|
72
|
+
- Load files not in PROTOCOL.yaml scoping read-set for the current query type
|
|
73
|
+
- Defer STATE.md decision recording to end of session
|
|
74
|
+
- Skip cascade checks after file changes
|
|
75
|
+
- Load multiple specialist .context/ files for a single query
|
|
76
|
+
- Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
|
|
77
|
+
|
|
78
|
+
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|
|
79
|
+
|
|
80
|
+
## First session
|
|
81
|
+
|
|
82
|
+
<!-- AGENT: If PROJECT.md contains {placeholder} text, this is a first session. -->
|
|
83
|
+
Follow the onboarding protocol in `.context/METHODOLOGY.md` — it guides you through
|
|
84
|
+
greenfield (4 stages) or brownfield (5 stages) setup with checkpoints at each step.
|
|
85
|
+
|
|
86
|
+
## Before ending this response
|
|
87
|
+
|
|
88
|
+
Read `.context/PROTOCOL.yaml` `close_check`. For each triggered item,
|
|
89
|
+
update the target file now. A response that modifies files but skips
|
|
90
|
+
triggered obligations is incomplete.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# {Project Name} — Agent Entry Point
|
|
2
|
+
|
|
3
|
+
<!-- INSTRUCTION: Replace {Project Name} and write a 1-2 sentence project description below -->
|
|
4
|
+
{Describe what your project does, its architecture, and key technologies.}
|
|
5
|
+
|
|
6
|
+
## On every query
|
|
7
|
+
|
|
8
|
+
1. This file is auto-loaded — read it first
|
|
9
|
+
2. Read `STATE.md` for current position, decisions, blockers
|
|
10
|
+
3. Read `.context/PROTOCOL.yaml` for scoping, cascade, and conventions
|
|
11
|
+
4. Scope query against PROTOCOL.yaml `scoping:` section
|
|
12
|
+
5. After work, check PROTOCOL.yaml `close_check` before ending response
|
|
13
|
+
|
|
14
|
+
## Settings
|
|
15
|
+
|
|
16
|
+
mode: checkpoint
|
|
17
|
+
<!-- autonomous | checkpoint | collaborative | supervised -->
|
|
18
|
+
<!-- checkpoint: propose plan, wait for approval, report at completion (default) -->
|
|
19
|
+
|
|
20
|
+
tier: full
|
|
21
|
+
<!-- lite | standard | full -->
|
|
22
|
+
<!-- lite: minimal rules, STATE.md only — for Haiku or simple projects -->
|
|
23
|
+
<!-- standard: core rules + context pairing — for Sonnet (default) -->
|
|
24
|
+
<!-- full: all rules, all intelligence layer files — for Opus or complex projects -->
|
|
25
|
+
|
|
26
|
+
method_version: 1.6
|
|
27
|
+
<!-- Use `wwa status` to compare against latest -->
|
|
28
|
+
|
|
29
|
+
## CLI tools (optional)
|
|
30
|
+
|
|
31
|
+
Install: `npm install -g agent-method` (then use `wwa`), or `pip install wwa-tools`.
|
|
32
|
+
|
|
33
|
+
| When you want to... | Run |
|
|
34
|
+
|---------------------|-----|
|
|
35
|
+
| Validate this entry point | `wwa check` |
|
|
36
|
+
| See what type of project this is | `wwa scan` |
|
|
37
|
+
| Test how a query routes | `wwa project-discovery` / `wwa context-refresh` / `wwa plan-create` (see CLI docs) |
|
|
38
|
+
| See current plan status | `wwa plan` |
|
|
39
|
+
| Get implementation guidance | `wwa implement` |
|
|
40
|
+
| View project review dashboard | `wwa review` |
|
|
41
|
+
| Show management digest | `wwa digest` |
|
|
42
|
+
| Session close + project snapshot | `wwa close` |
|
|
43
|
+
| Extract a refinement report | `wwa refine` |
|
|
44
|
+
| Extract a case study (with project tokens) | `wwa casestudy` |
|
|
45
|
+
| Check docs coverage | `wwa docs` |
|
|
46
|
+
| Check methodology version | `wwa status` |
|
|
47
|
+
| Update methodology files | `wwa upgrade` |
|
|
48
|
+
| Set up a new project | `wwa init` |
|
|
49
|
+
| Run project discovery workflow | `wwa project-discovery` |
|
|
50
|
+
| Run context refresh workflow | `wwa context-refresh` |
|
|
51
|
+
| Run phase completion workflow | `wwa phase-complete` |
|
|
52
|
+
| Show routing for backlog | `wwa backlog` |
|
|
53
|
+
| Run planning workflow | `wwa plan-create` |
|
|
54
|
+
| Run dependency analysis workflow | `wwa dependency-analysis` |
|
|
55
|
+
| Run debt assessment workflow | `wwa debt-assessment` |
|
|
56
|
+
| Run docs update workflow | `wwa docs-update` |
|
|
57
|
+
| Run cross-reference workflow | `wwa cross-reference` |
|
|
58
|
+
| Append to backlog / decision / finding / session / summary | `wwa add <type> [content]` |
|
|
59
|
+
|
|
60
|
+
When doing **project review** or **self-review** sessions, use the collection checklist for capture format: `docs/internal/review/collection-checklist.md` (if present).
|
|
61
|
+
|
|
62
|
+
<!-- INSTRUCTION: The agent can suggest these commands when the user asks about validation,
|
|
63
|
+
project setup, or methodology updates. All commands auto-detect project type and find
|
|
64
|
+
entry points automatically. Add --json for machine-readable output. -->
|
|
65
|
+
|
|
66
|
+
## Do not
|
|
67
|
+
|
|
68
|
+
- Modify project source code, tests, or pre-existing documentation through methodology operations — only create/modify methodology files (STATE.md, .context/, PLAN.md, etc.)
|
|
69
|
+
- Delete existing project files during brownfield integration — methodology is additive only
|
|
70
|
+
- Load files not in PROTOCOL.yaml scoping read-set for the current query type
|
|
71
|
+
- Defer STATE.md decision recording to end of session
|
|
72
|
+
- Skip cascade checks after file changes
|
|
73
|
+
- Load multiple specialist .context/ files for a single query
|
|
74
|
+
- Record routine queries in STATE.md or SESSION-LOG.md — only decisions, blockers, and high-effort work warrant documentation
|
|
75
|
+
|
|
76
|
+
<!-- INSTRUCTION: Add project-specific "do not" rules as you discover common mistakes -->
|
|
77
|
+
|
|
78
|
+
## First session
|
|
79
|
+
|
|
80
|
+
<!-- AGENT: If PROJECT.md contains {placeholder} text, this is a first session. -->
|
|
81
|
+
Follow the onboarding protocol in `.context/METHODOLOGY.md` — it guides you through
|
|
82
|
+
greenfield (4 stages) or brownfield (5 stages) setup with checkpoints at each step.
|
|
83
|
+
|
|
84
|
+
## Before ending this response
|
|
85
|
+
|
|
86
|
+
Read `.context/PROTOCOL.yaml` `close_check`. For each triggered item,
|
|
87
|
+
update the target file now. A response that modifies files but skips
|
|
88
|
+
triggered obligations is incomplete.
|