@cluesmith/codev 1.1.0 → 1.1.1
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/dist/agent-farm/cli.d.ts.map +1 -1
- package/dist/agent-farm/cli.js +19 -0
- package/dist/agent-farm/cli.js.map +1 -1
- package/dist/agent-farm/commands/cleanup.d.ts.map +1 -1
- package/dist/agent-farm/commands/cleanup.js +18 -1
- package/dist/agent-farm/commands/cleanup.js.map +1 -1
- package/dist/agent-farm/commands/consult.d.ts +16 -0
- package/dist/agent-farm/commands/consult.d.ts.map +1 -0
- package/dist/agent-farm/commands/consult.js +51 -0
- package/dist/agent-farm/commands/consult.js.map +1 -0
- package/dist/agent-farm/commands/open.js +6 -6
- package/dist/agent-farm/commands/open.js.map +1 -1
- package/dist/agent-farm/commands/spawn.d.ts.map +1 -1
- package/dist/agent-farm/commands/spawn.js +48 -42
- package/dist/agent-farm/commands/spawn.js.map +1 -1
- package/dist/agent-farm/commands/start.d.ts.map +1 -1
- package/dist/agent-farm/commands/start.js +8 -14
- package/dist/agent-farm/commands/start.js.map +1 -1
- package/dist/agent-farm/commands/util.js +2 -2
- package/dist/agent-farm/commands/util.js.map +1 -1
- package/dist/agent-farm/db/errors.d.ts +4 -0
- package/dist/agent-farm/db/errors.d.ts.map +1 -1
- package/dist/agent-farm/db/errors.js +8 -0
- package/dist/agent-farm/db/errors.js.map +1 -1
- package/dist/agent-farm/servers/dashboard-server.js +113 -71
- package/dist/agent-farm/servers/dashboard-server.js.map +1 -1
- package/dist/agent-farm/servers/open-server.d.ts +9 -0
- package/dist/agent-farm/servers/open-server.d.ts.map +1 -0
- package/dist/agent-farm/servers/{annotate-server.js → open-server.js} +17 -15
- package/dist/agent-farm/servers/open-server.js.map +1 -0
- package/dist/agent-farm/servers/tower-server.js +4 -7
- package/dist/agent-farm/servers/tower-server.js.map +1 -1
- package/dist/agent-farm/state.d.ts +5 -0
- package/dist/agent-farm/state.d.ts.map +1 -1
- package/dist/agent-farm/state.js +17 -0
- package/dist/agent-farm/state.js.map +1 -1
- package/dist/agent-farm/types.d.ts +1 -1
- package/dist/agent-farm/types.d.ts.map +1 -1
- package/dist/agent-farm/utils/config.d.ts.map +1 -1
- package/dist/agent-farm/utils/config.js +13 -7
- package/dist/agent-farm/utils/config.js.map +1 -1
- package/dist/agent-farm/utils/port-registry.d.ts +1 -1
- package/dist/agent-farm/utils/port-registry.d.ts.map +1 -1
- package/dist/agent-farm/utils/port-registry.js +1 -1
- package/dist/agent-farm/utils/port-registry.js.map +1 -1
- package/dist/agent-farm/utils/shell.d.ts +19 -0
- package/dist/agent-farm/utils/shell.d.ts.map +1 -1
- package/dist/agent-farm/utils/shell.js +28 -0
- package/dist/agent-farm/utils/shell.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +18 -0
- package/dist/cli.js.map +1 -1
- package/dist/commands/adopt.d.ts +3 -0
- package/dist/commands/adopt.d.ts.map +1 -1
- package/dist/commands/adopt.js +31 -25
- package/dist/commands/adopt.js.map +1 -1
- package/dist/commands/consult/index.d.ts +3 -2
- package/dist/commands/consult/index.d.ts.map +1 -1
- package/dist/commands/consult/index.js +128 -54
- package/dist/commands/consult/index.js.map +1 -1
- package/dist/commands/doctor.d.ts.map +1 -1
- package/dist/commands/doctor.js +30 -34
- package/dist/commands/doctor.js.map +1 -1
- package/dist/commands/eject.d.ts +18 -0
- package/dist/commands/eject.d.ts.map +1 -0
- package/dist/commands/eject.js +149 -0
- package/dist/commands/eject.js.map +1 -0
- package/dist/commands/init.d.ts +3 -0
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +32 -27
- package/dist/commands/init.js.map +1 -1
- package/dist/lib/projectlist-parser.d.ts +70 -0
- package/dist/lib/projectlist-parser.d.ts.map +1 -0
- package/dist/lib/projectlist-parser.js +200 -0
- package/dist/lib/projectlist-parser.js.map +1 -0
- package/dist/lib/skeleton.d.ts +41 -0
- package/dist/lib/skeleton.d.ts.map +1 -0
- package/dist/lib/skeleton.js +110 -0
- package/dist/lib/skeleton.js.map +1 -0
- package/dist/lib/templates.d.ts +2 -1
- package/dist/lib/templates.d.ts.map +1 -1
- package/dist/lib/templates.js +11 -10
- package/dist/lib/templates.js.map +1 -1
- package/package.json +4 -3
- package/{templates → skeleton}/DEPENDENCIES.md +2 -48
- package/{templates → skeleton}/agents/codev-updater.md +4 -3
- package/skeleton/bin/agent-farm +7 -0
- package/skeleton/docs/commands/agent-farm.md +469 -0
- package/skeleton/docs/commands/codev.md +253 -0
- package/skeleton/docs/commands/consult.md +286 -0
- package/skeleton/docs/commands/overview.md +107 -0
- package/{templates → skeleton}/protocols/experiment/protocol.md +2 -2
- package/{templates → skeleton}/protocols/spider/protocol.md +7 -7
- package/{templates/protocols/spider-solo → skeleton/protocols/spider}/templates/plan.md +22 -1
- package/{templates/protocols/spider-solo → skeleton/protocols/spider}/templates/spec.md +30 -1
- package/skeleton/protocols/tick/protocol.md +277 -0
- package/skeleton/resources/lessons-learned.md +30 -0
- package/skeleton/resources/workflow-reference.md +229 -0
- package/{templates → skeleton}/roles/architect.md +2 -0
- package/{templates → skeleton}/roles/builder.md +2 -0
- package/skeleton/roles/review-types/impl-review.md +56 -0
- package/skeleton/roles/review-types/integration-review.md +68 -0
- package/skeleton/roles/review-types/plan-review.md +59 -0
- package/skeleton/roles/review-types/pr-ready.md +72 -0
- package/skeleton/roles/review-types/spec-review.md +55 -0
- package/{templates → skeleton}/templates/projectlist.md +17 -16
- package/dist/agent-farm/servers/annotate-server.d.ts +0 -9
- package/dist/agent-farm/servers/annotate-server.d.ts.map +0 -1
- package/dist/agent-farm/servers/annotate-server.js.map +0 -1
- package/templates/annotate.html +0 -903
- package/templates/bin/agent-farm +0 -18
- package/templates/bin/annotate-server.js +0 -140
- package/templates/dashboard-split.html +0 -1679
- package/templates/dashboard.html +0 -149
- package/templates/protocols/spider/templates/plan.md +0 -169
- package/templates/protocols/spider/templates/review.md +0 -207
- package/templates/protocols/spider/templates/spec.md +0 -140
- package/templates/protocols/spider-solo/protocol.md +0 -619
- package/templates/protocols/tick/protocol.md +0 -250
- package/templates/tower.html +0 -1032
- /package/{templates/AGENTS.md → skeleton/AGENTS.md.template} +0 -0
- /package/{templates/CLAUDE.md → skeleton/CLAUDE.md.template} +0 -0
- /package/{templates → skeleton}/agents/architecture-documenter.md +0 -0
- /package/{templates → skeleton}/agents/spider-protocol-updater.md +0 -0
- /package/{templates → skeleton}/bin/codev-doctor +0 -0
- /package/{templates → skeleton}/builders.md +0 -0
- /package/{templates → skeleton}/config.json +0 -0
- /package/{templates → skeleton}/plans/.gitkeep +0 -0
- /package/{templates → skeleton}/protocols/experiment/templates/notes.md +0 -0
- /package/{templates → skeleton}/protocols/maintain/protocol.md +0 -0
- /package/{templates/protocols/spider-solo → skeleton/protocols/spider}/templates/review.md +0 -0
- /package/{templates → skeleton}/protocols/tick/templates/plan.md +0 -0
- /package/{templates → skeleton}/protocols/tick/templates/review.md +0 -0
- /package/{templates → skeleton}/protocols/tick/templates/spec.md +0 -0
- /package/{templates → skeleton}/reviews/.gitkeep +0 -0
- /package/{templates → skeleton}/roles/consultant.md +0 -0
- /package/{templates → skeleton}/specs/.gitkeep +0 -0
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
# consult - AI Consultation CLI
|
|
2
|
+
|
|
3
|
+
The `consult` command provides a unified interface for AI consultation with external models (Gemini, Codex, Claude). Use it for code reviews, spec reviews, and general questions.
|
|
4
|
+
|
|
5
|
+
## Synopsis
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
consult -m <model> <subcommand> [args] [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Required Option
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
-m, --model <model> Model to use (required)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Models
|
|
18
|
+
|
|
19
|
+
| Model | Alias | CLI Used | Notes |
|
|
20
|
+
|-------|-------|----------|-------|
|
|
21
|
+
| `gemini` | `pro` | gemini-cli | Pure text analysis, fast |
|
|
22
|
+
| `codex` | `gpt` | @openai/codex | Shell command exploration, thorough |
|
|
23
|
+
| `claude` | `opus` | @anthropic-ai/claude-code | Balanced analysis |
|
|
24
|
+
|
|
25
|
+
## Options
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
-n, --dry-run Show what would execute without running
|
|
29
|
+
-t, --type <type> Review type (see Review Types below)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Subcommands
|
|
33
|
+
|
|
34
|
+
### consult pr
|
|
35
|
+
|
|
36
|
+
Review a pull request.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
consult -m <model> pr <number>
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
**Arguments:**
|
|
43
|
+
- `number` - PR number to review
|
|
44
|
+
|
|
45
|
+
**Description:**
|
|
46
|
+
|
|
47
|
+
Reviews a GitHub pull request. The consultant reads:
|
|
48
|
+
- PR info and description
|
|
49
|
+
- Comments and discussions
|
|
50
|
+
- Diff of all changes
|
|
51
|
+
- File metadata
|
|
52
|
+
|
|
53
|
+
Outputs a structured review with verdict: APPROVE, REQUEST_CHANGES, or COMMENT.
|
|
54
|
+
|
|
55
|
+
**Examples:**
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# Review PR #42 with Gemini
|
|
59
|
+
consult -m gemini pr 42
|
|
60
|
+
|
|
61
|
+
# Review with Codex (more thorough, slower)
|
|
62
|
+
consult -m codex pr 42
|
|
63
|
+
|
|
64
|
+
# Dry run to see command
|
|
65
|
+
consult -m gemini pr 42 --dry-run
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
### consult spec
|
|
71
|
+
|
|
72
|
+
Review a specification.
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
consult -m <model> spec <number>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**Arguments:**
|
|
79
|
+
- `number` - Spec number to review (e.g., `42` for `codev/specs/0042-*.md`)
|
|
80
|
+
|
|
81
|
+
**Description:**
|
|
82
|
+
|
|
83
|
+
Reviews a specification file for:
|
|
84
|
+
- Clarity and completeness
|
|
85
|
+
- Technical feasibility
|
|
86
|
+
- Edge cases and error scenarios
|
|
87
|
+
- Security considerations
|
|
88
|
+
- Testing strategy
|
|
89
|
+
|
|
90
|
+
If a matching plan exists, it's included for context.
|
|
91
|
+
|
|
92
|
+
**Examples:**
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# Review spec 42
|
|
96
|
+
consult -m gemini spec 42
|
|
97
|
+
|
|
98
|
+
# With specific review type
|
|
99
|
+
consult -m gemini spec 42 --type spec-review
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
### consult plan
|
|
105
|
+
|
|
106
|
+
Review an implementation plan.
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
consult -m <model> plan <number>
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
**Arguments:**
|
|
113
|
+
- `number` - Plan number to review (e.g., `42` for `codev/plans/0042-*.md`)
|
|
114
|
+
|
|
115
|
+
**Description:**
|
|
116
|
+
|
|
117
|
+
Reviews an implementation plan for:
|
|
118
|
+
- Alignment with specification
|
|
119
|
+
- Implementation approach
|
|
120
|
+
- Task breakdown and ordering
|
|
121
|
+
- Risk identification
|
|
122
|
+
- Testing strategy
|
|
123
|
+
|
|
124
|
+
If a matching spec exists, it's included for context.
|
|
125
|
+
|
|
126
|
+
**Example:**
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
consult -m gemini plan 42
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
### consult general
|
|
135
|
+
|
|
136
|
+
General AI consultation.
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
consult -m <model> general "<query>"
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
**Arguments:**
|
|
143
|
+
- `query` - Question or request (quoted string)
|
|
144
|
+
|
|
145
|
+
**Description:**
|
|
146
|
+
|
|
147
|
+
Sends a free-form query to the consultant. The consultant role is still loaded, so responses follow the consultant guidelines.
|
|
148
|
+
|
|
149
|
+
**Examples:**
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
# Ask about code design
|
|
153
|
+
consult -m gemini general "What's the best way to structure auth middleware?"
|
|
154
|
+
|
|
155
|
+
# Get architecture advice
|
|
156
|
+
consult -m codex general "Review src/lib/database.ts for potential issues"
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Review Types
|
|
162
|
+
|
|
163
|
+
Use `--type` to load stage-specific review prompts:
|
|
164
|
+
|
|
165
|
+
| Type | Stage | Use Case |
|
|
166
|
+
|------|-------|----------|
|
|
167
|
+
| `spec-review` | conceived | Review specification completeness |
|
|
168
|
+
| `plan-review` | specified | Review implementation plan |
|
|
169
|
+
| `impl-review` | implementing | Review code implementation |
|
|
170
|
+
| `pr-ready` | implemented | Final check before PR |
|
|
171
|
+
| `integration-review` | committed | Architect's integration review |
|
|
172
|
+
|
|
173
|
+
**Example:**
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
consult -m gemini spec 42 --type spec-review
|
|
177
|
+
consult -m codex pr 68 --type integration-review
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## Parallel Consultation (3-Way Reviews)
|
|
183
|
+
|
|
184
|
+
For thorough reviews, run multiple models in parallel:
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
# Using background processes
|
|
188
|
+
consult -m gemini spec 42 &
|
|
189
|
+
consult -m codex spec 42 &
|
|
190
|
+
consult -m claude spec 42 &
|
|
191
|
+
wait
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Or with separate terminal sessions for better output separation.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## Performance
|
|
199
|
+
|
|
200
|
+
| Model | Typical Time | Approach |
|
|
201
|
+
|-------|--------------|----------|
|
|
202
|
+
| Gemini | ~120-150s | Pure text analysis |
|
|
203
|
+
| Codex | ~200-250s | Shell command exploration |
|
|
204
|
+
| Claude | ~60-120s | Balanced tool use |
|
|
205
|
+
|
|
206
|
+
Codex is slower because it executes shell commands (git show, rg, etc.) sequentially. It's more thorough but takes ~2x longer than Gemini.
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
## Prerequisites
|
|
211
|
+
|
|
212
|
+
Install the model CLIs you plan to use:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
# Claude
|
|
216
|
+
npm install -g @anthropic-ai/claude-code
|
|
217
|
+
|
|
218
|
+
# Codex
|
|
219
|
+
npm install -g @openai/codex
|
|
220
|
+
|
|
221
|
+
# Gemini
|
|
222
|
+
# See: https://github.com/google-gemini/gemini-cli
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
Configure API keys:
|
|
226
|
+
- Claude: `ANTHROPIC_API_KEY`
|
|
227
|
+
- Codex: `OPENAI_API_KEY`
|
|
228
|
+
- Gemini: `GOOGLE_API_KEY` or `GEMINI_API_KEY`
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## The Consultant Role
|
|
233
|
+
|
|
234
|
+
The consultant role (`codev/roles/consultant.md`) defines behavior:
|
|
235
|
+
- Provides second perspectives on decisions
|
|
236
|
+
- Offers alternatives and considerations
|
|
237
|
+
- Works constructively (not adversarial, not a rubber stamp)
|
|
238
|
+
- Uses `git show <branch>:<file>` for PR reviews
|
|
239
|
+
|
|
240
|
+
Customize by ejecting and modifying:
|
|
241
|
+
|
|
242
|
+
```bash
|
|
243
|
+
codev eject roles/consultant.md
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
---
|
|
247
|
+
|
|
248
|
+
## Query Logging
|
|
249
|
+
|
|
250
|
+
All consultations are logged to `.consult/history.log`:
|
|
251
|
+
|
|
252
|
+
```
|
|
253
|
+
2024-01-15T10:30:00.000Z model=gemini duration=142.3s query=Review spec 0042...
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
## Examples
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
# Quick spec review
|
|
262
|
+
consult -m gemini spec 42
|
|
263
|
+
|
|
264
|
+
# Thorough PR review
|
|
265
|
+
consult -m codex pr 68
|
|
266
|
+
|
|
267
|
+
# Architecture question
|
|
268
|
+
consult -m claude general "How should I structure the caching layer?"
|
|
269
|
+
|
|
270
|
+
# Dry run to see command
|
|
271
|
+
consult -m gemini pr 42 --dry-run
|
|
272
|
+
|
|
273
|
+
# 3-way parallel review
|
|
274
|
+
consult -m gemini spec 42 &
|
|
275
|
+
consult -m codex spec 42 &
|
|
276
|
+
consult -m claude spec 42 &
|
|
277
|
+
wait
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
## See Also
|
|
283
|
+
|
|
284
|
+
- [codev](codev.md) - Project management commands
|
|
285
|
+
- [af](agent-farm.md) - Agent Farm commands
|
|
286
|
+
- [overview](overview.md) - CLI overview
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Codev CLI Command Reference
|
|
2
|
+
|
|
3
|
+
Codev provides three CLI tools for AI-assisted software development:
|
|
4
|
+
|
|
5
|
+
| Tool | Description |
|
|
6
|
+
|------|-------------|
|
|
7
|
+
| `codev` | Project setup, maintenance, and framework commands |
|
|
8
|
+
| `af` | Agent Farm - multi-agent orchestration for development |
|
|
9
|
+
| `consult` | AI consultation with external models (Gemini, Codex, Claude) |
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Create a new project
|
|
15
|
+
codev init my-project
|
|
16
|
+
|
|
17
|
+
# Or add codev to an existing project
|
|
18
|
+
codev adopt
|
|
19
|
+
|
|
20
|
+
# Check your environment
|
|
21
|
+
codev doctor
|
|
22
|
+
|
|
23
|
+
# Start the architect dashboard
|
|
24
|
+
af start
|
|
25
|
+
|
|
26
|
+
# Consult an AI model about a spec
|
|
27
|
+
consult -m gemini spec 42
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Installation
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install -g @cluesmith/codev
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This installs all three commands globally: `codev`, `af`, and `consult`.
|
|
37
|
+
|
|
38
|
+
## Command Summaries
|
|
39
|
+
|
|
40
|
+
### codev - Project Management
|
|
41
|
+
|
|
42
|
+
| Command | Description |
|
|
43
|
+
|---------|-------------|
|
|
44
|
+
| `codev init [name]` | Create a new codev project |
|
|
45
|
+
| `codev adopt` | Add codev to an existing project |
|
|
46
|
+
| `codev doctor` | Check system dependencies |
|
|
47
|
+
| `codev update` | Update codev templates and protocols |
|
|
48
|
+
| `codev eject [path]` | Copy embedded files for customization |
|
|
49
|
+
| `codev tower` | Cross-project dashboard |
|
|
50
|
+
|
|
51
|
+
See [codev.md](codev.md) for full documentation.
|
|
52
|
+
|
|
53
|
+
### af - Agent Farm
|
|
54
|
+
|
|
55
|
+
| Command | Description |
|
|
56
|
+
|---------|-------------|
|
|
57
|
+
| `af start` | Start the architect dashboard |
|
|
58
|
+
| `af stop` | Stop all agent farm processes |
|
|
59
|
+
| `af spawn` | Spawn a new builder |
|
|
60
|
+
| `af status` | Show status of all agents |
|
|
61
|
+
| `af cleanup` | Clean up a builder worktree |
|
|
62
|
+
| `af send` | Send instructions to a builder |
|
|
63
|
+
| `af open` | Open file annotation viewer |
|
|
64
|
+
| `af util` | Spawn a utility shell |
|
|
65
|
+
|
|
66
|
+
See [agent-farm.md](agent-farm.md) for full documentation.
|
|
67
|
+
|
|
68
|
+
### consult - AI Consultation
|
|
69
|
+
|
|
70
|
+
| Subcommand | Description |
|
|
71
|
+
|------------|-------------|
|
|
72
|
+
| `consult pr <num>` | Review a pull request |
|
|
73
|
+
| `consult spec <num>` | Review a specification |
|
|
74
|
+
| `consult plan <num>` | Review an implementation plan |
|
|
75
|
+
| `consult general "<query>"` | General consultation |
|
|
76
|
+
|
|
77
|
+
See [consult.md](consult.md) for full documentation.
|
|
78
|
+
|
|
79
|
+
## Global Options
|
|
80
|
+
|
|
81
|
+
All codev commands support:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
--version Show version number
|
|
85
|
+
--help Show help for any command
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Configuration
|
|
89
|
+
|
|
90
|
+
Customize agent-farm commands via `codev/config.json`:
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"shell": {
|
|
95
|
+
"architect": "claude --model opus",
|
|
96
|
+
"builder": "claude --model sonnet",
|
|
97
|
+
"shell": "bash"
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Related Documentation
|
|
103
|
+
|
|
104
|
+
- [SPIDER Protocol](../protocols/spider/protocol.md) - Multi-phase development workflow
|
|
105
|
+
- [TICK Protocol](../protocols/tick/protocol.md) - Fast amendment workflow
|
|
106
|
+
- [Architect Role](../roles/architect.md) - Architect responsibilities
|
|
107
|
+
- [Builder Role](../roles/builder.md) - Builder responsibilities
|
|
@@ -10,7 +10,7 @@ Disciplined experimentation: Each experiment gets its own directory with `notes.
|
|
|
10
10
|
|
|
11
11
|
**Use for**: Testing approaches, evaluating models, prototyping, proof-of-concept work, research spikes
|
|
12
12
|
|
|
13
|
-
**Skip for**: Production code (use SPIDER
|
|
13
|
+
**Skip for**: Production code (use SPIDER), simple one-off scripts, well-understood implementations (use TICK)
|
|
14
14
|
|
|
15
15
|
## Structure
|
|
16
16
|
|
|
@@ -141,7 +141,7 @@ What should be done based on findings?
|
|
|
141
141
|
|
|
142
142
|
## Integration with Other Protocols
|
|
143
143
|
|
|
144
|
-
### Experiment → SPIDER
|
|
144
|
+
### Experiment → SPIDER
|
|
145
145
|
When an experiment validates an approach for production use:
|
|
146
146
|
|
|
147
147
|
1. Create a specification referencing the experiment
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# SPIDER Protocol
|
|
2
2
|
|
|
3
|
+
> **Quick Reference**: See `codev/resources/workflow-reference.md` for stage diagrams and common commands.
|
|
4
|
+
|
|
3
5
|
## Prerequisites
|
|
4
6
|
|
|
5
7
|
**Required for Multi-Agent Consultation**:
|
|
6
|
-
-
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
- Option 1: "Would you like help installing Zen MCP server?"
|
|
10
|
-
- Option 2: "Use spider-solo protocol instead (no multi-agent consultation)"
|
|
8
|
+
- The `consult` CLI must be available (installed with `npm install -g @cluesmith/codev`)
|
|
9
|
+
- At least one consultation backend: `claude`, `gemini-cli`, or `codex`
|
|
10
|
+
- Check with: `codev doctor` or `consult --help`
|
|
11
11
|
|
|
12
12
|
## Protocol Configuration
|
|
13
13
|
|
|
@@ -17,11 +17,11 @@
|
|
|
17
17
|
Multi-agent consultation is **ENABLED BY DEFAULT** when using SPIDER protocol.
|
|
18
18
|
|
|
19
19
|
**DEFAULT AGENTS:**
|
|
20
|
-
- **GPT-5**: Primary reviewer for architecture, feasibility, and code quality
|
|
20
|
+
- **GPT-5 Codex**: Primary reviewer for architecture, feasibility, and code quality
|
|
21
21
|
- **Gemini Pro**: Secondary reviewer for completeness, edge cases, and alternative approaches
|
|
22
22
|
|
|
23
23
|
**DISABLING CONSULTATION:**
|
|
24
|
-
|
|
24
|
+
To run SPIDER without consultation, say "without consultation" when starting work.
|
|
25
25
|
|
|
26
26
|
**CUSTOM AGENTS:**
|
|
27
27
|
The user can specify different agents by saying: "use SPIDER with consultation from [agent1] and [agent2]"
|
|
@@ -166,4 +166,25 @@ Phase 1 ──→ Phase 2 ──→ Phase 3
|
|
|
166
166
|
| [Date] | [What changed] | [Why] | [Who] |
|
|
167
167
|
|
|
168
168
|
## Notes
|
|
169
|
-
[Additional context, assumptions, or considerations]
|
|
169
|
+
[Additional context, assumptions, or considerations]
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## Amendment History
|
|
174
|
+
|
|
175
|
+
This section tracks all TICK amendments to this plan. TICKs modify both the spec and plan together as an atomic unit.
|
|
176
|
+
|
|
177
|
+
<!-- When adding a TICK amendment, add a new entry below this line in chronological order -->
|
|
178
|
+
|
|
179
|
+
<!--
|
|
180
|
+
### TICK-001: [Amendment Title] (YYYY-MM-DD)
|
|
181
|
+
|
|
182
|
+
**Changes**:
|
|
183
|
+
- [Phase added]: [Description of new phase]
|
|
184
|
+
- [Phase modified]: [What was updated]
|
|
185
|
+
- [Implementation steps]: [New steps added]
|
|
186
|
+
|
|
187
|
+
**Review**: See `reviews/####-name-tick-001.md`
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
-->
|
|
@@ -137,4 +137,33 @@ Note: All consultation feedback has been incorporated directly into the relevant
|
|
|
137
137
|
- [ ] Expert AI Consultation Complete
|
|
138
138
|
|
|
139
139
|
## Notes
|
|
140
|
-
[Any additional context or considerations not covered above]
|
|
140
|
+
[Any additional context or considerations not covered above]
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Amendments
|
|
145
|
+
|
|
146
|
+
This section tracks all TICK amendments to this specification. TICKs are lightweight changes that refine an existing spec rather than creating a new one.
|
|
147
|
+
|
|
148
|
+
<!-- When adding a TICK amendment, add a new entry below this line in chronological order -->
|
|
149
|
+
|
|
150
|
+
<!--
|
|
151
|
+
### TICK-001: [Amendment Title] (YYYY-MM-DD)
|
|
152
|
+
|
|
153
|
+
**Summary**: [One-line description of what changed]
|
|
154
|
+
|
|
155
|
+
**Problem Addressed**:
|
|
156
|
+
[Why this amendment was needed - what gap or issue in the original spec]
|
|
157
|
+
|
|
158
|
+
**Spec Changes**:
|
|
159
|
+
- [Section modified]: [What changed and why]
|
|
160
|
+
- [New section added]: [Purpose]
|
|
161
|
+
|
|
162
|
+
**Plan Changes**:
|
|
163
|
+
- [Phase added/modified]: [Description]
|
|
164
|
+
- [Implementation steps]: [What was updated]
|
|
165
|
+
|
|
166
|
+
**Review**: See `reviews/####-name-tick-001.md`
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
-->
|