@zik000/archai 0.2.0 → 0.2.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/README.md +124 -543
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +27 -4
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/uninstall.d.ts.map +1 -1
- package/dist/commands/uninstall.js +1 -0
- package/dist/commands/uninstall.js.map +1 -1
- package/dist/scaffold/copy-core-agents.d.ts.map +1 -1
- package/dist/scaffold/copy-core-agents.js +3 -1
- package/dist/scaffold/copy-core-agents.js.map +1 -1
- package/dist/scaffold/create-claude-settings.d.ts.map +1 -1
- package/dist/scaffold/create-claude-settings.js +4 -3
- package/dist/scaffold/create-claude-settings.js.map +1 -1
- package/dist/scaffold/create-config.d.ts +2 -2
- package/dist/scaffold/create-config.d.ts.map +1 -1
- package/dist/scaffold/create-config.js +35 -37
- package/dist/scaffold/create-config.js.map +1 -1
- package/dist/utils/migration.d.ts.map +1 -1
- package/dist/utils/migration.js +1 -0
- package/dist/utils/migration.js.map +1 -1
- package/package.json +1 -1
- package/templates/CLAUDE.md +27 -0
- package/templates/core-agents/code-reviewer.md +36 -138
- package/templates/core-agents/deep-analyst.md +10 -25
- package/templates/core-agents/finalization-agent.md +10 -88
- package/templates/core-agents/implementation-agent.md +30 -112
- package/templates/core-agents/iteration-controller.md +93 -494
- package/templates/core-agents/plan-validator.md +1 -1
- package/templates/core-agents/quick-fix.md +56 -0
- package/templates/core-agents/task-orchestrator.md +20 -132
- package/templates/core-agents/tdd-designer.md +45 -139
- package/templates/specialist-meta.md +3 -3
package/README.md
CHANGED
|
@@ -1,627 +1,212 @@
|
|
|
1
1
|
# archai
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**A team of AI agents for Claude Code — not just one assistant, but a full development workflow.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Archai scaffolds a multi-agent system that plans before it codes, validates before it implements, and tests before it ships. One command sets it up. Claude Code does the rest.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
[JOIN DISCORD](https://discord.gg/2Y88888888)
|
|
12
|
-
|
|
13
|
-
## Philosophy: Think Before Acting
|
|
7
|
+
```
|
|
8
|
+
Plan → Implement → Finalize
|
|
9
|
+
```
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
[Join our Discord](https://discord.gg/J3wgDb4YJv)
|
|
16
12
|
|
|
17
|
-
|
|
18
|
-
2. **Phase 2: Implementation Loop** - Implement, test, review (only after Phase 1 approved)
|
|
19
|
-
3. **Phase 3: Finalization** - Verify, cleanup, commit, push, CI/CD verification
|
|
13
|
+
---
|
|
20
14
|
|
|
21
|
-
|
|
15
|
+
## Why archai?
|
|
22
16
|
|
|
23
|
-
|
|
17
|
+
Without structure, AI assistants jump straight to code — skipping analysis, missing edge cases, and producing work that needs reworking. archai fixes this with a **three-phase workflow**:
|
|
24
18
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
│ (Think deeply BEFORE any code) │
|
|
29
|
-
│ │
|
|
30
|
-
│ ┌─────────┐ ┌───────────┐ ┌───────────┐ ┌──────────┐ ┌─────────┐ │
|
|
31
|
-
│ │ THINK │──▶│ VALIDATE │──▶│ TEST │──▶│ VALIDATE │──▶│ RETHINK │ │
|
|
32
|
-
│ │ (deep- │ │ (plan- │ │ DESIGN │ │ TESTS │ │ (deep- │ │
|
|
33
|
-
│ │ analyst)│ │ validator)│ │ (tdd- │ │ (critic) │ │ analyst)│ │
|
|
34
|
-
│ └─────────┘ └───────────┘ │ designer) │ └──────────┘ └─────────┘ │
|
|
35
|
-
│ ▲ └───────────┘ │ │
|
|
36
|
-
│ │ ◀─── ITERATE 2-4x ───────────────────────┘ │
|
|
37
|
-
│ │
|
|
38
|
-
│ EXIT: Plan + Tests validated + All questions answered │
|
|
39
|
-
└─────────────────────────────────────────────────────────────────────────────┘
|
|
40
|
-
│
|
|
41
|
-
▼
|
|
42
|
-
╔═══════════════════════════════════════════╗
|
|
43
|
-
║ 🛑 AWAIT USER PLAN APPROVAL 🛑 ║
|
|
44
|
-
╚═══════════════════════════════════════════╝
|
|
45
|
-
│
|
|
46
|
-
▼ (only on APPROVE)
|
|
47
|
-
┌─────────────────────────────────────────────────────────────────────────────┐
|
|
48
|
-
│ PHASE 2: IMPLEMENTATION LOOP │
|
|
49
|
-
│ (Only after user approves plan) │
|
|
50
|
-
│ │
|
|
51
|
-
│ ┌──────────────┐ ┌─────────┐ ┌────────────┐ │
|
|
52
|
-
│ │ IMPLEMENT │───▶│ TEST │───▶│ REVIEW │ │
|
|
53
|
-
│ │(implement- │ │ (run) │ │ (code- │ │
|
|
54
|
-
│ │ation-agent) │ │ │ │ reviewer) │ │
|
|
55
|
-
│ └──────────────┘ └─────────┘ └────────────┘ │
|
|
56
|
-
│ ▲ │ │
|
|
57
|
-
│ │ ◀─── ITERATE ───────────┘ │
|
|
58
|
-
│ │
|
|
59
|
-
│ EXIT: Tests pass + Review approved │
|
|
60
|
-
└─────────────────────────────────────────────────────────────────────────────┘
|
|
61
|
-
│
|
|
62
|
-
▼
|
|
63
|
-
╔═══════════════════════════════════════════╗
|
|
64
|
-
║ 🛑 AWAIT USER FINAL APPROVAL 🛑 ║
|
|
65
|
-
╚═══════════════════════════════════════════╝
|
|
66
|
-
│
|
|
67
|
-
▼ (only on APPROVE)
|
|
68
|
-
┌─────────────────────────────────────────────────────────────────────────────┐
|
|
69
|
-
│ PHASE 3: FINALIZATION │
|
|
70
|
-
│ (finalization-agent handles) │
|
|
71
|
-
│ │
|
|
72
|
-
│ ┌──────────┐ ┌─────────┐ ┌────────┐ ┌────────┐ ┌─────────────┐ │
|
|
73
|
-
│ │ VERIFY │──▶│ QUALITY │──▶│CLEANUP │──▶│ COMMIT │──▶│ WAIT FOR │ │
|
|
74
|
-
│ │ CRITERIA │ │ CHECKS │ │ │ │ + PUSH │ │ CI/CD │ │
|
|
75
|
-
│ └──────────┘ └─────────┘ └────────┘ └────────┘ └─────────────┘ │
|
|
76
|
-
│ │
|
|
77
|
-
│ EXIT: CI passes + All verified │
|
|
78
|
-
└─────────────────────────────────────────────────────────────────────────────┘
|
|
79
|
-
│
|
|
80
|
-
▼
|
|
81
|
-
┌──────────────┐
|
|
82
|
-
│ COMPLETE │
|
|
83
|
-
└──────────────┘
|
|
84
|
-
```
|
|
19
|
+
1. **Planning Loop** — Analyze the problem, validate the plan, design tests (2-4 iterations)
|
|
20
|
+
2. **Implementation Loop** — Code, test, review (only after you approve the plan)
|
|
21
|
+
3. **Finalization** — Quality checks, cleanup, commit, push, CI verification
|
|
85
22
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
- **10 Core Agents** - Pre-built orchestration agents for planning, implementation, and quality assurance
|
|
89
|
-
- **Critical Review Mode** - Automated plan review via separate SDK session for blind spot detection
|
|
90
|
-
- **Permission Presets** - Configurable permission settings (permissive/strict/custom) with safety guardrails
|
|
91
|
-
- **Dynamic Specialists** - Claude Code generates project-specific specialists based on your tech stack
|
|
92
|
-
- **Three-Phase Workflow** - Planning Loop → (Optional Critical Review) → Implementation Loop → Finalization
|
|
93
|
-
- **Language Agnostic** - Works with any language, framework, or tech stack
|
|
94
|
-
- **Task Management** - Built-in epic/task tracking system
|
|
23
|
+
You stay in control with approval gates between phases. Or use **critical review mode** to let a separate AI session review the plan automatically.
|
|
95
24
|
|
|
96
25
|
## Quick Start
|
|
97
26
|
|
|
98
27
|
```bash
|
|
99
|
-
# Install globally
|
|
100
28
|
npm install -g @zik000/archai
|
|
101
|
-
|
|
102
|
-
# Initialize in your project
|
|
103
29
|
cd your-project
|
|
104
30
|
archai init
|
|
105
|
-
|
|
106
|
-
# Fill in the generated files (or use wizards):
|
|
107
|
-
archai setup-project # Interactive project description wizard
|
|
108
|
-
archai setup-config # Interactive configuration wizard
|
|
109
|
-
|
|
110
|
-
# Generate specialist agents
|
|
111
|
-
archai generate
|
|
112
|
-
|
|
113
|
-
# Start using with Claude Code
|
|
114
|
-
claude
|
|
115
|
-
|
|
116
|
-
# Manual mode (default) - user approves at both gates
|
|
117
|
-
> "Use iteration-controller for: [your task]"
|
|
118
|
-
|
|
119
|
-
# Critical review mode - auto-approve with SDK critical review
|
|
120
|
-
> "Use iteration-controller with critical-review for: [your task]"
|
|
121
31
|
```
|
|
122
32
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
- **Node.js 18+**
|
|
126
|
-
- **Claude Code CLI** - Install from [claude.ai/code](https://claude.ai/code)
|
|
127
|
-
- Claude Code must be authenticated
|
|
128
|
-
|
|
129
|
-
## Commands
|
|
130
|
-
|
|
131
|
-
### archai init
|
|
132
|
-
|
|
133
|
-
Initialize archai in your project. Runs an interactive wizard to gather project information.
|
|
33
|
+
That's it. archai detects your tech stack and creates everything you need. Now open Claude Code:
|
|
134
34
|
|
|
135
35
|
```bash
|
|
136
|
-
|
|
137
|
-
archai init --skip-wizard # Use detected defaults
|
|
138
|
-
archai init --force # Smart update with file comparison
|
|
139
|
-
archai init --dry-run # Preview what would be created
|
|
140
|
-
archai init -y # Non-interactive mode (CI-friendly)
|
|
36
|
+
claude
|
|
141
37
|
```
|
|
142
38
|
|
|
143
|
-
|
|
144
|
-
- **Legacy Migration**: Automatically migrates pre-0.2.0 installations to version tracking
|
|
145
|
-
- **File Comparison**: Compares existing files against templates
|
|
146
|
-
- **Conflict Detection**: Identifies user modifications vs archai updates
|
|
147
|
-
- **Interactive Resolution**: Prompts for action on conflicting files
|
|
148
|
-
- **Automatic Backup**: Creates backup before `--force` operations
|
|
149
|
-
|
|
150
|
-
Creates:
|
|
151
|
-
- `.claude/agents/` - Agent definitions
|
|
152
|
-
- `.claude/version.json` - Version and file hash tracking
|
|
153
|
-
- `.claude/settings.local.json` - Permission settings (permissive mode by default)
|
|
154
|
-
- `.claude/state/` - Working state (gitignored)
|
|
155
|
-
- `.knowledge/` - Permanent knowledge base
|
|
156
|
-
- `.tasks/` - Task management
|
|
157
|
-
- `archai.config.md` - Configuration file
|
|
158
|
-
- `PROMPTS.md` - Quick reference for all prompts
|
|
159
|
-
|
|
160
|
-
### archai generate
|
|
39
|
+
And tell it what to build:
|
|
161
40
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
```bash
|
|
165
|
-
archai generate # Generate all specialists
|
|
166
|
-
archai generate --dry-run # Preview without writing
|
|
167
|
-
archai generate -y # Skip confirmation
|
|
41
|
+
```
|
|
42
|
+
> Use iteration-controller for: add user authentication with JWT
|
|
168
43
|
```
|
|
169
44
|
|
|
170
|
-
|
|
171
|
-
1. Reads your `archai.config.md`
|
|
172
|
-
2. Calls Claude Code CLI to generate each specialist
|
|
173
|
-
3. Writes specialists to `.claude/agents/`
|
|
45
|
+
The agent system takes over — plans the work, waits for your approval, implements it, runs tests, and commits.
|
|
174
46
|
|
|
175
|
-
###
|
|
47
|
+
### For small fixes
|
|
176
48
|
|
|
177
|
-
|
|
49
|
+
Skip the full workflow:
|
|
178
50
|
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
archai setup-project --force # Overwrite existing content
|
|
51
|
+
```
|
|
52
|
+
> Use quick-fix for: rename the userId variable to accountId
|
|
182
53
|
```
|
|
183
54
|
|
|
184
|
-
|
|
185
|
-
- Project overview and description
|
|
186
|
-
- Architecture and key modules
|
|
187
|
-
- Domain concepts and workflows
|
|
188
|
-
- Technical constraints
|
|
189
|
-
- Development guidelines
|
|
190
|
-
- Current state and priorities
|
|
191
|
-
|
|
192
|
-
### archai setup-config
|
|
193
|
-
|
|
194
|
-
Interactive wizard to configure your project settings.
|
|
55
|
+
### Optional setup wizards
|
|
195
56
|
|
|
196
57
|
```bash
|
|
197
|
-
archai setup-
|
|
198
|
-
archai setup-config
|
|
58
|
+
archai setup-project # Describe your project architecture
|
|
59
|
+
archai setup-config # Configure commands, specialists, permissions
|
|
60
|
+
archai generate # Generate project-specific specialist agents
|
|
199
61
|
```
|
|
200
62
|
|
|
201
|
-
|
|
202
|
-
- Tech stack (languages, frameworks, testing)
|
|
203
|
-
- Build commands (install, build, test, lint, dev)
|
|
204
|
-
- Project structure
|
|
205
|
-
- Specialist agents (with interactive loop to define multiple)
|
|
206
|
-
- Permission presets (permissive/strict/custom) with `.claude/settings.local.json`
|
|
207
|
-
- MCP/Skills placeholder section
|
|
63
|
+
## How to Use
|
|
208
64
|
|
|
209
|
-
###
|
|
65
|
+
### The Main Workflow
|
|
210
66
|
|
|
211
|
-
|
|
67
|
+
For any non-trivial task, use `iteration-controller`. It orchestrates the entire three-phase workflow:
|
|
212
68
|
|
|
213
|
-
```
|
|
214
|
-
|
|
69
|
+
```
|
|
70
|
+
> Use iteration-controller for: [describe your task]
|
|
215
71
|
```
|
|
216
72
|
|
|
217
|
-
|
|
218
|
-
-
|
|
219
|
-
-
|
|
220
|
-
-
|
|
221
|
-
|
|
73
|
+
**What happens:**
|
|
74
|
+
1. `deep-analyst` analyzes your codebase and creates an implementation plan
|
|
75
|
+
2. `plan-validator` challenges the plan and finds gaps
|
|
76
|
+
3. `tdd-designer` designs tests before any code is written
|
|
77
|
+
4. **You review and approve the plan** (or request revisions)
|
|
78
|
+
5. `implementation-agent` builds it, `code-reviewer` verifies it
|
|
79
|
+
6. `finalization-agent` runs quality checks, commits, and pushes
|
|
222
80
|
|
|
223
|
-
###
|
|
81
|
+
### Critical Review Mode
|
|
224
82
|
|
|
225
|
-
|
|
83
|
+
For routine tasks where you trust the process, skip manual plan approval:
|
|
226
84
|
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
archai update --all # Force update all files
|
|
230
|
-
archai update --dry-run # Preview what would change
|
|
231
|
-
archai update -y # Non-interactive mode (CI-friendly)
|
|
85
|
+
```
|
|
86
|
+
> Use iteration-controller with critical-review for: [your task]
|
|
232
87
|
```
|
|
233
88
|
|
|
234
|
-
|
|
235
|
-
- **Three-Way Comparison**: Detects if you, archai, or both modified files
|
|
236
|
-
- **Auto-Merge**: Automatically merges settings.json (union arrays) and .gitignore (append)
|
|
237
|
-
- **User Protection**: Skips files you modified (unless you choose otherwise)
|
|
238
|
-
- **Specialist Protection**: Never overwrites generated specialist agents
|
|
239
|
-
- **Automatic Backup**: Creates backup before any changes
|
|
240
|
-
- **Deprecated Detection**: Identifies files no longer in archai templates
|
|
89
|
+
A separate Claude session reviews the plan for blind spots. If it passes, implementation starts automatically. If issues are found, it falls back to asking you.
|
|
241
90
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
|
246
|
-
| Unchanged | Identical to template | Skip |
|
|
247
|
-
| Updated by archai | New template version | Auto-update |
|
|
248
|
-
| Modified by you | You changed it | Ask/skip |
|
|
249
|
-
| Conflict | Both changed | Ask/merge |
|
|
250
|
-
| Generated | Specialist file | Protected |
|
|
91
|
+
| Mode | When to use | Plan approval |
|
|
92
|
+
|------|-------------|---------------|
|
|
93
|
+
| Manual (default) | Learning, high-stakes, security-sensitive | You approve |
|
|
94
|
+
| Critical review | Routine tasks, well-understood features | Auto if review passes |
|
|
251
95
|
|
|
252
|
-
###
|
|
96
|
+
### Quick Fix
|
|
253
97
|
|
|
254
|
-
|
|
98
|
+
For small, obvious changes (typos, renames, config tweaks, 1-3 files):
|
|
255
99
|
|
|
256
|
-
```bash
|
|
257
|
-
archai rollback # Interactive backup selection
|
|
258
|
-
archai rollback --list # List all available backups
|
|
259
|
-
archai rollback <timestamp> # Restore specific backup
|
|
260
|
-
archai rollback --dry-run # Preview what would be restored
|
|
261
|
-
archai rollback -y # Skip confirmation
|
|
262
100
|
```
|
|
263
|
-
|
|
264
|
-
**Features:**
|
|
265
|
-
- Lists backups with timestamps, reasons, and file counts
|
|
266
|
-
- Full restore of all files from backup
|
|
267
|
-
- Updates version.json after rollback
|
|
268
|
-
|
|
269
|
-
### archai cleanup
|
|
270
|
-
|
|
271
|
-
Clean up deprecated files and old backups.
|
|
272
|
-
|
|
273
|
-
```bash
|
|
274
|
-
archai cleanup # Show cleanup status
|
|
275
|
-
archai cleanup --deprecated # Remove deprecated/orphaned files
|
|
276
|
-
archai cleanup --backups # Prune old backups (keeps 5)
|
|
277
|
-
archai cleanup --all # Clean everything
|
|
278
|
-
archai cleanup --dry-run # Preview what would be removed
|
|
279
|
-
archai cleanup -y # Skip confirmation
|
|
101
|
+
> Use quick-fix for: [small change]
|
|
280
102
|
```
|
|
281
103
|
|
|
282
|
-
|
|
283
|
-
- Identifies files tracked by archai but no longer in templates
|
|
284
|
-
- Prunes old backups (configurable with `--keep-backups <count>`)
|
|
285
|
-
- Safe: confirms before deleting
|
|
104
|
+
No planning docs, no approval gates. If the change turns out to be bigger than expected, it tells you to use `iteration-controller` instead.
|
|
286
105
|
|
|
287
|
-
###
|
|
106
|
+
### Task Management
|
|
288
107
|
|
|
289
|
-
|
|
108
|
+
For managing multiple tasks across an epic:
|
|
290
109
|
|
|
291
|
-
```bash
|
|
292
|
-
archai uninstall # Interactive removal
|
|
293
|
-
archai uninstall --dry-run # Preview what would be removed
|
|
294
|
-
archai uninstall --keep-knowledge # Preserve .knowledge/ directory
|
|
295
|
-
archai uninstall --force # Skip confirmation
|
|
296
110
|
```
|
|
297
|
-
|
|
298
|
-
### Debug Mode
|
|
299
|
-
|
|
300
|
-
Add `--debug` to any command for verbose logging:
|
|
301
|
-
|
|
302
|
-
```bash
|
|
303
|
-
archai init --debug
|
|
304
|
-
archai doctor --debug
|
|
111
|
+
> Use task-orchestrator for: work through the tasks in .tasks/inbox/
|
|
305
112
|
```
|
|
306
113
|
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
### Phase 1 Agents (Planning)
|
|
310
|
-
|
|
311
|
-
| Agent | Purpose | Focus |
|
|
312
|
-
|-------|---------|-------|
|
|
313
|
-
| `deep-analyst` | Deep analysis, initial planning, rethinking | Understanding the REAL problem |
|
|
314
|
-
| `plan-validator` | Challenge plans, find gaps | Breaking assumptions |
|
|
315
|
-
| `tdd-designer` | Design tests BEFORE code | Real user workflows |
|
|
316
|
-
| `critical-reviewer` | SDK-spawned blind spot detection | Fresh unbiased perspective |
|
|
317
|
-
|
|
318
|
-
### Phase 2 Agents (Implementation)
|
|
114
|
+
It claims tasks, creates branches, spawns the workflow, and tracks progress.
|
|
319
115
|
|
|
320
|
-
|
|
321
|
-
|-------|---------|-------|
|
|
322
|
-
| `implementation-agent` | Execute the validated plan | Following specs exactly |
|
|
323
|
-
| `code-reviewer` | Verify implementation | Finding problems |
|
|
116
|
+
### Standalone Agents
|
|
324
117
|
|
|
325
|
-
|
|
118
|
+
You can use any agent directly:
|
|
326
119
|
|
|
327
|
-
| Agent |
|
|
328
|
-
|-------|---------|-------|
|
|
329
|
-
| `cleanup-agent` | Clean temporary work files | Before committing |
|
|
330
|
-
| `finalization-agent` | Post-implementation finalization | Verify, cleanup, commit, push, CI/CD |
|
|
331
|
-
|
|
332
|
-
### Orchestrator
|
|
333
|
-
|
|
334
|
-
| Agent | Purpose |
|
|
120
|
+
| Agent | Use for |
|
|
335
121
|
|-------|---------|
|
|
336
|
-
| `
|
|
337
|
-
| `
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
-
|
|
345
|
-
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
122
|
+
| `deep-analyst` | Understanding code, analyzing a problem |
|
|
123
|
+
| `tdd-designer` | Designing test suites |
|
|
124
|
+
| `cleanup-agent` | Cleaning temp files before committing |
|
|
125
|
+
|
|
126
|
+
## Agents (11 Core)
|
|
127
|
+
|
|
128
|
+
| Agent | Phase | Role |
|
|
129
|
+
|-------|-------|------|
|
|
130
|
+
| `iteration-controller` | Orchestrator | Manages all three phases with iteration limits |
|
|
131
|
+
| `deep-analyst` | Planning | Deep analysis and implementation planning |
|
|
132
|
+
| `plan-validator` | Planning | Adversarial plan review — finds gaps |
|
|
133
|
+
| `tdd-designer` | Planning | Designs tests before code, with concrete values |
|
|
134
|
+
| `critical-reviewer` | Planning | Blind review via separate SDK session |
|
|
135
|
+
| `implementation-agent` | Implementation | Autonomous execution of approved plan |
|
|
136
|
+
| `code-reviewer` | Implementation | Verifies against acceptance criteria |
|
|
137
|
+
| `cleanup-agent` | Finalization | Removes temp files, archives state |
|
|
138
|
+
| `finalization-agent` | Finalization | Quality checks, commit, push, CI/CD |
|
|
139
|
+
| `task-orchestrator` | Workflow | Epic/task lifecycle management |
|
|
140
|
+
| `quick-fix` | Standalone | Fast single-pass for small changes |
|
|
141
|
+
|
|
142
|
+
**Specialist agents** are generated from your config with `archai generate` — they understand your specific tech stack, file paths, and conventions.
|
|
356
143
|
|
|
357
|
-
|
|
358
|
-
- Dependency analysis
|
|
359
|
-
- Risk assessment
|
|
360
|
-
- Test design with concrete values
|
|
361
|
-
- All questions answered
|
|
362
|
-
|
|
363
|
-
### 2. Approval Gates (Two Modes)
|
|
364
|
-
|
|
365
|
-
Phase 1 outputs a **plan document** to `.claude/plans/{task}.md`. What happens next depends on the mode:
|
|
366
|
-
|
|
367
|
-
**Manual Mode** (default):
|
|
368
|
-
- Workflow **STOPS** and waits for user to: APPROVE / REVISE / REJECT
|
|
369
|
-
- User reviews plan before any code is written
|
|
370
|
-
- User reviews implementation before finalization
|
|
371
|
-
|
|
372
|
-
**Critical Review Mode** (`with critical-review`):
|
|
373
|
-
- Spawns a **separate SDK session** to critically review the plan
|
|
374
|
-
- Fresh perspective catches blind spots the planning agent missed
|
|
375
|
-
- Up to 2 review iterations with plan revisions
|
|
376
|
-
- Auto-proceeds if review passes (no CRITICAL/HIGH issues)
|
|
377
|
-
- Falls back to manual if unresolved issues after 2 iterations
|
|
378
|
-
|
|
379
|
-
| Mode | Plan Gate | Final Gate | Best For |
|
|
380
|
-
|------|-----------|------------|----------|
|
|
381
|
-
| Manual | User approval | User approval | High-stakes changes, learning |
|
|
382
|
-
| Critical Review | Auto (if passed) | Auto (if passed) | Routine tasks, trusted workflows |
|
|
383
|
-
|
|
384
|
-
### 3. Tests Define Done
|
|
385
|
-
|
|
386
|
-
Tests are designed FIRST, in Phase 1. Implementation follows. Tests must:
|
|
387
|
-
- Reflect real user workflows
|
|
388
|
-
- Use concrete values
|
|
389
|
-
- FAIL when code is wrong
|
|
390
|
-
- NOT mock core logic
|
|
391
|
-
|
|
392
|
-
### 4. Validation Is Adversarial
|
|
393
|
-
|
|
394
|
-
`plan-validator` exists to find problems, not approve plans. Expect:
|
|
395
|
-
- 2-4 planning iterations minimum
|
|
396
|
-
- Questions that force deeper thinking
|
|
397
|
-
- Rejection of vague plans
|
|
398
|
-
|
|
399
|
-
### 5. Iterate Until Right
|
|
400
|
-
|
|
401
|
-
Phase 1: Iterate until plan is specific, validated, and tests designed
|
|
402
|
-
Phase 2: Iterate until tests pass and review approves
|
|
403
|
-
|
|
404
|
-
## Permission Presets
|
|
405
|
-
|
|
406
|
-
archai configures Claude Code permissions via `.claude/settings.local.json`. Three presets available:
|
|
407
|
-
|
|
408
|
-
### Permissive (Default)
|
|
409
|
-
|
|
410
|
-
Close to `--dangerously-skip-permissions` but with safety guardrails. Allows most operations while blocking irreversible actions:
|
|
411
|
-
|
|
412
|
-
**Always Denied** (even in permissive mode):
|
|
413
|
-
- Destructive file ops: `rm -rf *`, `rmdir /s`
|
|
414
|
-
- Force git: `git push --force`, `git reset --hard`
|
|
415
|
-
- System damage: `sudo *`, `chmod 777`, `mkfs*`
|
|
416
|
-
- Credentials: `cat ~/.ssh/*`, `echo $*SECRET*`
|
|
417
|
-
- Remote code exec: `curl * | bash`, `wget * | sh`
|
|
418
|
-
- Database destruction: `DROP DATABASE`, `TRUNCATE TABLE`
|
|
419
|
-
|
|
420
|
-
### Strict
|
|
421
|
-
|
|
422
|
-
Production-safe preset. Only allows read-only operations and controlled writes:
|
|
423
|
-
|
|
424
|
-
**Allowed**:
|
|
425
|
-
- Package management: `npm install`, `pip install`, etc.
|
|
426
|
-
- Build/test: `tsc`, `eslint`, `jest`, `pytest`
|
|
427
|
-
- Read operations: `cat`, `grep`, `ls`, `git status`, `git diff`
|
|
428
|
-
- Safe git: `git add`, `git commit`, `git checkout -b`
|
|
429
|
-
|
|
430
|
-
**Denied** (in addition to Always Denied):
|
|
431
|
-
- Network: `curl`, `wget`, `ssh`, `scp`
|
|
432
|
-
- Publish: `npm publish`, `pip upload`
|
|
433
|
-
- Push: `git push` (any form)
|
|
434
|
-
- Process control: `kill`, `pkill`
|
|
144
|
+
## Commands
|
|
435
145
|
|
|
436
|
-
|
|
146
|
+
| Command | Purpose |
|
|
147
|
+
|---------|---------|
|
|
148
|
+
| `archai init` | Initialize archai in your project (smart — handles existing setups) |
|
|
149
|
+
| `archai update` | Update agents/templates with smart file comparison |
|
|
150
|
+
| `archai generate` | Generate specialist agents from your config |
|
|
151
|
+
| `archai setup-project` | Interactive wizard for project description |
|
|
152
|
+
| `archai setup-config` | Interactive wizard for config, commands, permissions |
|
|
153
|
+
| `archai doctor` | Validate your setup |
|
|
154
|
+
| `archai rollback` | Restore from automatic backup |
|
|
155
|
+
| `archai cleanup` | Remove deprecated files and old backups |
|
|
156
|
+
| `archai uninstall` | Remove archai from your project |
|
|
437
157
|
|
|
438
|
-
|
|
158
|
+
All commands support `--dry-run` to preview changes and `-y` for non-interactive CI mode.
|
|
439
159
|
|
|
440
|
-
###
|
|
160
|
+
### Key flags
|
|
441
161
|
|
|
442
|
-
Permissions validate **each segment** of chained commands:
|
|
443
162
|
```bash
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
archai tracks file states in `.claude/version.json` to enable smart updates:
|
|
451
|
-
|
|
452
|
-
```json
|
|
453
|
-
{
|
|
454
|
-
"schemaVersion": 1,
|
|
455
|
-
"archai": "0.2.0",
|
|
456
|
-
"installedAt": "2026-02-01T10:00:00Z",
|
|
457
|
-
"lastUpdated": "2026-02-05T14:30:00Z",
|
|
458
|
-
"files": {
|
|
459
|
-
".claude/agents/deep-analyst.md": {
|
|
460
|
-
"baseHash": "abc123def456",
|
|
461
|
-
"isGenerated": false
|
|
462
|
-
},
|
|
463
|
-
".claude/agents/frontend-specialist.md": {
|
|
464
|
-
"baseHash": null,
|
|
465
|
-
"isGenerated": true
|
|
466
|
-
}
|
|
467
|
-
},
|
|
468
|
-
"expectedFiles": [".claude/agents/deep-analyst.md", "..."]
|
|
469
|
-
}
|
|
163
|
+
archai init --skip-wizard # Use detected defaults
|
|
164
|
+
archai init --force # Re-initialize with file comparison
|
|
165
|
+
archai update --all # Force update all files
|
|
166
|
+
archai rollback --list # Show available backups
|
|
167
|
+
archai cleanup --all # Remove deprecated files + prune backups
|
|
470
168
|
```
|
|
471
169
|
|
|
472
|
-
|
|
473
|
-
1. **baseHash**: SHA256 hash when archai installed the file
|
|
474
|
-
2. **currentHash**: Hash of file on disk now
|
|
475
|
-
3. **templateHash**: Hash of new archai template
|
|
476
|
-
|
|
477
|
-
**Three-Way Comparison:**
|
|
478
|
-
- `current == template` → Unchanged
|
|
479
|
-
- `current != base`, `template == base` → You modified it
|
|
480
|
-
- `current == base`, `template != base` → Archai updated it
|
|
481
|
-
- `current != base`, `template != base` → Conflict (both changed)
|
|
170
|
+
## Permission Presets
|
|
482
171
|
|
|
483
|
-
|
|
484
|
-
When you run `init` or `update` on an old installation, archai automatically:
|
|
485
|
-
1. Creates version.json
|
|
486
|
-
2. Compares existing files to current templates
|
|
487
|
-
3. Marks matching files as unmodified
|
|
488
|
-
4. Marks differing files as user-modified (conservative approach)
|
|
489
|
-
5. Marks `*-specialist.md` files as generated
|
|
172
|
+
archai configures Claude Code permissions via `.claude/settings.local.json`:
|
|
490
173
|
|
|
491
|
-
|
|
174
|
+
| Preset | Description |
|
|
175
|
+
|--------|-------------|
|
|
176
|
+
| **Permissive** (default) | Allows most operations. Blocks destructive actions: `rm -rf`, `git push --force`, `sudo`, credential access, database drops. |
|
|
177
|
+
| **Strict** | Read-only + controlled writes. No network, no push, no publish. Good for production environments. |
|
|
178
|
+
| **Custom** | Define your own allow/deny lists via the wizard. |
|
|
492
179
|
|
|
493
|
-
|
|
180
|
+
## Project Structure
|
|
494
181
|
|
|
495
182
|
```
|
|
496
183
|
your-project/
|
|
497
184
|
├── .claude/
|
|
498
|
-
│ ├── agents/
|
|
499
|
-
│
|
|
500
|
-
│
|
|
501
|
-
│
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
├── .knowledge/
|
|
508
|
-
│ ├── context/
|
|
509
|
-
│ │ └── project-description.md
|
|
510
|
-
│ ├── decisions/ # Architecture decisions
|
|
511
|
-
│ └── learnings/ # Learned patterns
|
|
512
|
-
├── .tasks/
|
|
513
|
-
│ ├── inbox/ # New tasks
|
|
514
|
-
│ ├── epics/ # Active work
|
|
515
|
-
│ ├── review/ # Awaiting merge
|
|
516
|
-
│ └── done/ # Completed
|
|
517
|
-
├── archai.config.md # Configuration
|
|
518
|
-
└── PROMPTS.md # Quick reference prompts
|
|
185
|
+
│ ├── agents/ # Core + specialist agent definitions
|
|
186
|
+
│ ├── plans/ # Approved implementation plans
|
|
187
|
+
│ ├── state/ # Working state (gitignored)
|
|
188
|
+
│ └── version.json # Version tracking for smart updates
|
|
189
|
+
├── .knowledge/ # Project context, decisions, learnings
|
|
190
|
+
├── .tasks/ # Task inbox, epics, review, done
|
|
191
|
+
├── archai.config.md # Project configuration
|
|
192
|
+
├── CLAUDE.md # Agentic behavior guidelines (auto-generated)
|
|
193
|
+
└── PROMPTS.md # Quick reference for all prompts
|
|
519
194
|
```
|
|
520
195
|
|
|
521
|
-
##
|
|
522
|
-
|
|
523
|
-
| Situation | Start With |
|
|
524
|
-
|-----------|------------|
|
|
525
|
-
| New feature | `iteration-controller` |
|
|
526
|
-
| Bug fix (complex) | `iteration-controller` |
|
|
527
|
-
| Bug fix (simple, <10 lines) | Direct fix, no agents |
|
|
528
|
-
| Understanding code | `deep-analyst` only |
|
|
529
|
-
| Test quality review | `tdd-designer` only |
|
|
530
|
-
| Before committing | `cleanup-agent` |
|
|
531
|
-
| Managing epics | `task-orchestrator` |
|
|
532
|
-
|
|
533
|
-
### When to Use Critical Review Mode
|
|
534
|
-
|
|
535
|
-
| Situation | Mode | Why |
|
|
536
|
-
|-----------|------|-----|
|
|
537
|
-
| Learning the workflow | Manual | See how planning works |
|
|
538
|
-
| High-stakes feature | Manual | Want full control |
|
|
539
|
-
| Security-sensitive code | Manual | Extra human review |
|
|
540
|
-
| Routine refactoring | Critical Review | Trust the review process |
|
|
541
|
-
| Well-understood feature | Critical Review | Faster iteration |
|
|
542
|
-
| Batch of similar tasks | Critical Review | Efficiency at scale |
|
|
543
|
-
|
|
544
|
-
## Why This Architecture?
|
|
545
|
-
|
|
546
|
-
### Problem: Incomplete Plans
|
|
547
|
-
|
|
548
|
-
"Handle edge cases" leads to implementation guessing.
|
|
549
|
-
|
|
550
|
-
**Solution**: `plan-validator` rejects vague plans, forces specificity.
|
|
551
|
-
|
|
552
|
-
### Problem: Code First, Think Later
|
|
553
|
-
|
|
554
|
-
Jumping to code before understanding leads to rewrites.
|
|
555
|
-
|
|
556
|
-
**Solution**: Three-phase architecture enforces 2-4 thinking iterations BEFORE any code.
|
|
557
|
-
|
|
558
|
-
### Problem: Tests Written To Pass
|
|
559
|
-
|
|
560
|
-
Tests written after code tend to validate the implementation, not the requirement.
|
|
561
|
-
|
|
562
|
-
**Solution**: Tests designed BEFORE implementation, based on user stories, not code.
|
|
563
|
-
|
|
564
|
-
### Problem: Agents Cut Corners
|
|
565
|
-
|
|
566
|
-
Without enforcement, agents skip steps and produce low-quality work.
|
|
567
|
-
|
|
568
|
-
**Solution**: Explicit phase gates, required artifacts, adversarial validation.
|
|
569
|
-
|
|
570
|
-
## Common Mistakes to Avoid
|
|
571
|
-
|
|
572
|
-
### Mistake 1: Skipping to implementation
|
|
573
|
-
```
|
|
574
|
-
# BAD
|
|
575
|
-
"Just implement the auth feature"
|
|
576
|
-
|
|
577
|
-
# GOOD
|
|
578
|
-
"Use iteration-controller to implement the auth feature.
|
|
579
|
-
Run Phase 1 first and wait for my APPROVE."
|
|
580
|
-
```
|
|
581
|
-
|
|
582
|
-
### Mistake 2: Approving vague plans
|
|
583
|
-
```
|
|
584
|
-
# BAD plan that should be REVISED
|
|
585
|
-
"Step 3: Handle edge cases"
|
|
586
|
-
|
|
587
|
-
# GOOD plan that can be APPROVED
|
|
588
|
-
"Step 3: Handle boundary values
|
|
589
|
-
- Empty input: Return validation error 'input_required'
|
|
590
|
-
- Input > 1000 chars: Truncate with warning
|
|
591
|
-
- Invalid characters: Reject with 'invalid_chars'"
|
|
592
|
-
```
|
|
593
|
-
|
|
594
|
-
### Mistake 3: Interrupting Phase 2
|
|
595
|
-
```
|
|
596
|
-
# BAD
|
|
597
|
-
[Agent implementing step 2]
|
|
598
|
-
You: "How's it going? Should I help?"
|
|
196
|
+
## Requirements
|
|
599
197
|
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
[Only interrupt if truly necessary]
|
|
603
|
-
```
|
|
198
|
+
- **Node.js 18+**
|
|
199
|
+
- **Claude Code CLI** — [claude.ai/code](https://claude.ai/code)
|
|
604
200
|
|
|
605
201
|
## Troubleshooting
|
|
606
202
|
|
|
607
|
-
|
|
608
|
-
1. Check if agent file content was passed in prompt
|
|
609
|
-
2. Verify output location is specified
|
|
610
|
-
3. Make task boundaries explicit
|
|
203
|
+
**Agent not following instructions?** Make sure agent file content is being passed and output locations are specified.
|
|
611
204
|
|
|
612
|
-
|
|
613
|
-
1. Check if tdd-designer used all test categories (correctness, edge, boundary)
|
|
614
|
-
2. Verify concrete values used (not "test with valid input")
|
|
205
|
+
**Planning keeps iterating?** After 4 iterations, it stops automatically. If requirements are unclear, it escalates to you.
|
|
615
206
|
|
|
616
|
-
|
|
617
|
-
1. After 4 iterations, check if requirements are unclear
|
|
618
|
-
2. May need to escalate to human for clarification
|
|
619
|
-
3. Check if plan-validator is rejecting for valid reasons
|
|
207
|
+
**Implementation failing?** After 5 fix attempts on the same step, it reports BLOCKED and stops. Check if the plan was specific enough.
|
|
620
208
|
|
|
621
|
-
|
|
622
|
-
1. Check if plan was specific enough
|
|
623
|
-
2. Review test design - were edge cases covered?
|
|
624
|
-
3. After 5 attempts on same error, escalate
|
|
209
|
+
**Tests too shallow?** Verify `tdd-designer` used concrete values and covered edge cases, not just happy paths.
|
|
625
210
|
|
|
626
211
|
## License
|
|
627
212
|
|
|
@@ -629,8 +214,4 @@ MIT
|
|
|
629
214
|
|
|
630
215
|
## Contributing
|
|
631
216
|
|
|
632
|
-
Contributions welcome!
|
|
633
|
-
|
|
634
|
-
---
|
|
635
|
-
|
|
636
|
-
Built with Claude Code.
|
|
217
|
+
Contributions welcome! Join the [Discord](https://discord.gg/J3wgDb4YJv) to discuss ideas.
|