@corbat-tech/coco 1.9.0 โ†’ 2.1.0

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 CHANGED
@@ -1,276 +1,457 @@
1
1
  <div align="center">
2
2
 
3
- # ๐Ÿฅฅ Coco
3
+ <img src="docs/assets/logo.png" alt="Coco โ€” autonomous AI coding agent" width="640"/>
4
4
 
5
- **The AI coding agent that actually delivers production-ready code**
5
+ <br/>
6
6
 
7
- [Features](#-features) โ€ข
8
- [Quick Start](#-quick-start) โ€ข
9
- [How It Works](#-how-it-works) โ€ข
10
- [Commands](#-commands) โ€ข
11
- [Documentation](#-documentation)
12
-
13
- [![NPM Version](https://img.shields.io/npm/v/@corbat-tech/coco?style=flat-square&color=blueviolet)](https://www.npmjs.com/package/@corbat-tech/coco)
14
- [![License](https://img.shields.io/badge/license-MIT-f5c542?style=flat-square)](LICENSE)
7
+ [![npm](https://img.shields.io/npm/v/@corbat-tech/coco?style=flat-square&color=a855f7&label=npm)](https://www.npmjs.com/package/@corbat-tech/coco)
8
+ [![Node](https://img.shields.io/badge/Node.js-22+-22c55e?style=flat-square&logo=nodedotjs&logoColor=white)](https://nodejs.org/)
15
9
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
16
- [![Node](https://img.shields.io/badge/Node.js-22+-339933?style=flat-square&logo=nodedotjs&logoColor=white)](https://nodejs.org/)
17
- [![Tests](https://img.shields.io/badge/tests-4350%2B-22c55e?style=flat-square)](https://github.com/corbat/corbat-coco/actions)
10
+ [![License](https://img.shields.io/badge/license-MIT-f59e0b?style=flat-square)](LICENSE)
11
+ [![Tests](https://img.shields.io/badge/tests-5290_passing-22c55e?style=flat-square)](https://github.com/corbat-tech/coco/actions)
18
12
 
19
- </div>
13
+ <br/>
20
14
 
21
- ---
15
+ [Install](#install) ยท [Quick Start](#quick-start) ยท [How It Works](#how-it-works) ยท [Providers](#providers) ยท [Skills](#skills) ยท [Docs](#documentation)
22
16
 
23
- ## The Problem
17
+ </div>
24
18
 
25
- Most AI coding tools generate code and walk away. If tests fail, types don't match, or security issues creep in โ€” **that's on you**.
19
+ ---
26
20
 
27
- ## The Solution
21
+ ## The one-line pitch
28
22
 
29
- **Coco doesn't just generate code. It iterates until it's right.**
23
+ Most AI tools write code and hand it back. If tests fail or security is off โ€” that's your problem. **Coco runs the loop for you**: write โ†’ test โ†’ measure โ†’ fix, until your code actually hits a quality bar worth shipping.
30
24
 
31
- After writing code, Coco automatically:
32
- - โœ… Runs your tests
33
- - ๐Ÿ“Š Measures quality across 12 dimensions
34
- - ๐Ÿ” Diagnoses what's wrong
35
- - ๐Ÿ”ง Fixes issues and repeats
25
+ ---
36
26
 
37
- **Until your code hits production-quality standards you define.**
27
+ ## What it looks like
38
28
 
39
29
  ```
40
- โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
41
- โ”‚ Generate โ”‚ โ”€โ”€โ–บ โ”‚ Test โ”‚ โ”€โ”€โ–บ โ”‚ Measure โ”‚ โ”€โ”€โ–บ โ”‚ Fix โ”‚
42
- โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
43
- โ”‚
44
- Score < 85? โ”‚ โ”€โ”€โ–บ Loop
45
- Score โ‰ฅ 85? โ”‚ โ”€โ”€โ–บ Done โœ…
30
+ $ coco "Add JWT authentication to the Express API"
31
+
32
+ โ—† Converging on requirements...
33
+ โ—† Designing architecture โ€” 3 tasks planned
34
+
35
+ Task 1/3 JWT middleware
36
+ ยท iter 1 โ”€โ”€ score 58 missing error handling, 0 tests written
37
+ ยท iter 2 โ”€โ”€ score 79 tests added, OWASP issue detected
38
+ ยท iter 3 โ”€โ”€ score 91 โœ“ converged
39
+
40
+ Task 2/3 Auth routes /login ยท /refresh ยท /logout
41
+ ยท iter 1 โ”€โ”€ score 71 coverage 42%, input not validated
42
+ ยท iter 2 โ”€โ”€ score 89 โœ“ converged
43
+
44
+ Task 3/3 Integration tests
45
+ ยท iter 1 โ”€โ”€ score 94 โœ“ converged first try
46
+
47
+ โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Quality Report โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
48
+ โ”‚ Correctness 96 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ”‚
49
+ โ”‚ Security 100 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ”‚
50
+ โ”‚ Test Coverage 88 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘ โ”‚
51
+ โ”‚ Complexity 91 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ”‚
52
+ โ”‚ Documentation 84 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘ โ”‚
53
+ โ”‚ โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ โ”‚
54
+ โ”‚ Overall 92 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ”‚
55
+ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
56
+
57
+ 3 files written ยท 47 tests ยท 88% coverage ยท 0 vulnerabilities
46
58
  ```
47
59
 
48
60
  ---
49
61
 
50
- ## โœจ Features
62
+ ## Why Coco
63
+
64
+ | What you usually do | What Coco does |
65
+ |---------------------|----------------|
66
+ | Write code, run tests manually, fix, repeat | Autonomous iterate-until-quality loop |
67
+ | Hope your reviewer catches security issues | OWASP pattern analysis on every iteration |
68
+ | Guess at test coverage | c8/v8 instrumentation, measured per task |
69
+ | One model, one provider, take it or leave it | 12 providers, switch any time |
70
+ | Workflows live in your head or Confluence | Reusable skills committed to the repo |
71
+
72
+ ### How Coco compares
73
+
74
+ | | Coco | Aider | Claude Code | Cursor |
75
+ |---|---|---|---|---|
76
+ | Quality convergence loop | โœ… | โŒ | โŒ | โŒ |
77
+ | Runs tests + measures coverage | โœ… | โŒ | โŒ | โŒ |
78
+ | Provider-agnostic (12 providers) | โœ… | โœ… | โŒ Anthropic only | Partial |
79
+ | Works in terminal | โœ… | โœ… | โœ… | โŒ IDE only |
80
+ | Reusable team workflows (Skills) | โœ… | โŒ | โœ… CLAUDE.md | โŒ |
81
+ | MCP tool integration | โœ… | โŒ | โœ… | โœ… |
82
+ | Local models (Ollama, LM Studio) | โœ… | โœ… | โŒ | Partial |
83
+ | Subscription-based providers | โœ… ChatGPT, Kimi Code | โŒ | โœ… Claude Max | โœ… |
51
84
 
52
- ### ๐Ÿ”„ **Quality Convergence Loop** (COCO Mode)
85
+ ---
53
86
 
54
- Not just code generation โ€” **iterative quality improvement**:
87
+ ## Install
55
88
 
56
- | Iteration | Score | Status |
57
- |:---------:|:-----:|--------|
58
- | **1** | 52 | Code generated โ€” 3 tests failing, no error handling |
59
- | **2** | 71 | Tests fixed, security vulnerability found |
60
- | **3** | 84 | Security patched, coverage 82% |
61
- | **4** | **91** | โœ… **All green โ€” quality converged** |
89
+ ### Prerequisites
62
90
 
63
- > Enable with `/coco` โ€” now **on by default** for better results
91
+ Coco requires **Node.js 22 or higher**. Check your version:
64
92
 
65
- ### ๐Ÿ“Š **12-Dimension Quality Scoring**
93
+ ```bash
94
+ node --version # should print v22.x.x or higher
95
+ ```
66
96
 
67
- Real metrics, not guesses:
97
+ Don't have Node.js? Install it for your platform:
68
98
 
69
- | Dimension | How It's Measured |
70
- |-----------|-------------------|
71
- | Test Coverage | c8/v8 instrumentation |
72
- | Security | Pattern matching + optional Snyk |
73
- | Complexity | Cyclomatic complexity (AST) |
74
- | Duplication | Line-based similarity |
75
- | Correctness | Test pass rate + build verification |
76
- | Style | oxlint / eslint / biome |
77
- | Documentation | JSDoc coverage |
78
- | + 5 more | Readability, Maintainability, Test Quality, Completeness, Robustness |
99
+ **macOS**
100
+ ```bash
101
+ # Homebrew (recommended)
102
+ brew install node
79
103
 
80
- ### ๐Ÿš€ **Full Release Pipeline**
104
+ # Or use the official installer: https://nodejs.org
105
+ ```
81
106
 
82
- Ship with confidence using `/ship`:
107
+ **Linux (Debian/Ubuntu)**
108
+ ```bash
109
+ # Via NodeSource (keeps Node up to date)
110
+ curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
111
+ sudo apt-get install -y nodejs
112
+ ```
83
113
 
114
+ **Linux (Fedora/RHEL)**
84
115
  ```bash
85
- /ship # Complete 10-step pipeline
116
+ sudo dnf install nodejs
86
117
  ```
87
118
 
88
- **Pipeline:** Preflight โ†’ Review โ†’ Tests โ†’ Lint โ†’ Branch โ†’ Version โ†’ Commit โ†’ PR โ†’ CI โ†’ Merge
119
+ **WSL2 (Windows)**
89
120
 
90
- Each step is interactive โ€” press `Ctrl+C` anytime to safely cancel.
121
+ Coco works great on WSL2. If you don't have WSL2 set up yet:
91
122
 
92
- ### ๐Ÿค– **Multi-Agent Architecture**
123
+ ```powershell
124
+ # In PowerShell (as Administrator)
125
+ wsl --install
126
+ ```
93
127
 
94
- Six specialized agents with automatic routing:
128
+ Then open your WSL2 terminal and follow the Linux instructions above.
95
129
 
96
- - **Researcher** โ€” Codebase exploration and analysis
97
- - **Coder** โ€” Code implementation (default)
98
- - **Tester** โ€” Test generation and coverage
99
- - **Reviewer** โ€” Quality auditing and code review
100
- - **Optimizer** โ€” Refactoring and performance
101
- - **Planner** โ€” Architecture and task decomposition
130
+ > **Native Windows is not supported.** Use WSL2 โ€” it gives you a full Linux environment on Windows with better performance and tool compatibility.
102
131
 
103
- ### ๐ŸŒ **Multi-Provider Support**
132
+ ---
104
133
 
105
- Bring your own API key:
134
+ ### Install Coco
106
135
 
107
- | Provider | Auth | Models |
108
- |----------|------|--------|
109
- | **Anthropic** | API key / OAuth | Claude Opus, Sonnet, Haiku |
110
- | **OpenAI** | API key | GPT-5.3 Codex, GPT-4.1, o4-mini |
111
- | **Google** | API key / gcloud | Gemini 3, 2.5 Pro/Flash |
112
- | **Ollama** | Local | Any local model |
113
- | **LM Studio** | Local | Any GGUF model |
114
- | **Moonshot** | API key | Kimi models |
136
+ Once Node.js 22+ is ready:
115
137
 
116
- ### โšก **Modern Terminal UX**
138
+ ```bash
139
+ # npm
140
+ npm install -g @corbat-tech/coco
117
141
 
118
- - **Ghost-text completion** โ€” Tab to accept suggestions
119
- - **Image paste** โ€” `Ctrl+V` to paste screenshots
120
- - **Intent recognition** โ€” Natural language โ†’ commands
121
- - **Full-access mode** โ€” `/full-access` for auto-approvals (with safety guards)
122
- - **Self-update** โ€” Type "update coco" anytime
142
+ # pnpm
143
+ pnpm add -g @corbat-tech/coco
144
+
145
+ # bun
146
+ bun add -g @corbat-tech/coco
147
+ ```
148
+
149
+ Verify the installation:
150
+
151
+ ```bash
152
+ coco --version
153
+ ```
123
154
 
124
155
  ---
125
156
 
126
- ## ๐Ÿš€ Quick Start
157
+ ## Quick Start
127
158
 
128
159
  ```bash
129
- # Install globally
130
- npm install -g @corbat-tech/coco
160
+ # Set your API key (Anthropic recommended, others work too)
161
+ export ANTHROPIC_API_KEY="sk-ant-..."
131
162
 
132
- # Start interactive mode
163
+ # Start the interactive REPL โ€” first run guides you through setup
133
164
  coco
134
165
 
135
- # Or use directly
136
- coco "Add user authentication with tests"
166
+ # Or go straight to a task
167
+ coco "Build a REST API for user management with tests"
168
+ ```
169
+
170
+ That's it. On first launch Coco walks you through choosing a provider and model.
171
+
172
+ **[5-minute tutorial โ†’](docs/guides/QUICK_START.md)**
173
+
174
+ ---
175
+
176
+ ## How It Works
177
+
178
+ Coco uses the **COCO methodology** โ€” four phases, fully automated:
179
+
180
+ ```
181
+ CONVERGE ORCHESTRATE COMPLETE OUTPUT
182
+ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
183
+ โ”‚ Understand โ”‚ โ”€โ”€โ–บ โ”‚ Design โ”‚ โ”€โ”€โ–บ โ”‚ Build with โ”‚ โ–บ โ”‚ Generate โ”‚
184
+ โ”‚ the task โ”‚ โ”‚ + backlog โ”‚ โ”‚ convergence โ”‚ โ”‚ CI/CD โ”‚
185
+ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
186
+ โ†‘ โ”‚
187
+ โ”‚ loopโ”‚ score < threshold
188
+ โ””โ”€โ”€โ”€โ”€โ”˜
137
189
  ```
138
190
 
139
- That's it. Coco walks you through provider setup on first launch.
191
+ **The convergence loop** is what sets Coco apart. After writing each task:
192
+
193
+ 1. Runs your test suite
194
+ 2. Scores the result across **12 quality dimensions**
195
+ 3. Identifies the weakest areas with specific diagnostics
196
+ 4. Generates a targeted fix and repeats
197
+ 5. Stops when the score meets your threshold (default: **85/100**)
198
+
199
+ **[Architecture deep dive โ†’](docs/architecture/ARCHITECTURE.md)**
140
200
 
141
201
  ---
142
202
 
143
- ## ๐Ÿ’ฌ Commands
203
+ ## 12-Dimension Quality Scoring
204
+
205
+ Not vibes โ€” real measurements from static analysis and test instrumentation:
144
206
 
145
- ### Slash Commands
207
+ | Dimension | How it's measured |
208
+ |-----------|-------------------|
209
+ | **Correctness** | Test pass rate + build verification |
210
+ | **Security** | OWASP pattern matching (must be 100 to ship) |
211
+ | **Test Coverage** | c8/v8 line + branch instrumentation |
212
+ | **Complexity** | Cyclomatic complexity via AST |
213
+ | **Duplication** | Line-based similarity detection |
214
+ | **Style** | oxlint / eslint / biome (your config) |
215
+ | **Documentation** | JSDoc / Javadoc coverage |
216
+ | **Readability** | Derived from complexity + naming |
217
+ | **Maintainability** | Maintainability Index (MI) |
218
+ | **Test Quality** | Assertion density, coverage distribution |
219
+ | **Completeness** | Requirements traceability |
220
+ | **Robustness** | Error handling, edge case coverage |
221
+
222
+ Language-specific analyzers for **TypeScript/JavaScript**, **React/TSX**, and **Java**.
223
+
224
+ **[Quality guide โ†’](docs/guides/QUALITY.md)**
225
+
226
+ ---
227
+
228
+ ## Commands
229
+
230
+ Type `/help` inside the REPL to see everything. The most useful ones day-to-day:
146
231
 
147
232
  | Command | What it does |
148
- |---------|-------------|
149
- | `/help` | Show available commands |
150
- | `/status` | Project status, git info, session stats |
233
+ |---------|--------------|
234
+ | `/coco [on\|off]` | Toggle quality convergence mode (default: on) |
235
+ | `/check` | Run typecheck + lint + tests inline |
151
236
  | `/review` | Code review with severity-rated findings |
152
237
  | `/diff` | Visual diff with syntax highlighting |
153
- | `/ship` | Full release pipeline (review โ†’ test โ†’ PR โ†’ merge) |
154
- | `/coco [on\|off]` | Toggle quality mode (default: ON) |
155
- | `/full-access [on\|off]` | Auto-approve safe commands |
156
- | `/compact` | Reduce context when conversation grows |
157
- | `/clear` | Clear conversation history |
238
+ | `/ship` | Full release: review โ†’ test โ†’ lint โ†’ branch โ†’ PR โ†’ merge |
239
+ | `/full-access [on\|off]` | Auto-approve safe tool calls |
240
+ | `/status` | Project status, git info, session stats |
241
+ | `/compact` | Compress context when the conversation grows long |
158
242
 
159
- ### Natural Language
243
+ You don't have to use slash commands. Natural language works:
160
244
 
161
- You don't need slash commands. Just talk:
245
+ ```
246
+ "review the auth module" โ†’ /review
247
+ "let's ship this" โ†’ /ship
248
+ "what changed since yesterday?" โ†’ /diff
249
+ "update coco" โ†’ updates to latest version
250
+ ```
162
251
 
163
- | You say | Coco does |
164
- |---------|-----------|
165
- | "review the code" | Runs `/review` |
166
- | "let's ship it" | Runs `/ship` |
167
- | "show me the changes" | Runs `/diff` |
168
- | **"update coco"** | **Runs `/update-coco`** |
252
+ Bilingual: English and Spanish both work out of the box.
169
253
 
170
- Bilingual support (English/Spanish).
254
+ **[Full cookbook and examples โ†’](docs/guides/COOKBOOK.md)**
171
255
 
172
256
  ---
173
257
 
174
- ## ๐ŸŽฏ How It Works
258
+ ## Providers
259
+
260
+ Coco is provider-agnostic. Bring your own key or run fully local:
261
+
262
+ | Provider | Models | Auth |
263
+ |----------|--------|------|
264
+ | **Anthropic** โญ | Claude Opus, Sonnet, Haiku | API key / OAuth |
265
+ | **OpenAI** | GPT-4.1, o4-mini, Codex | API key / OAuth |
266
+ | **Google** | Gemini 2.5 Pro/Flash | API key / gcloud |
267
+ | **Groq** | Llama 4, Mixtral, Gemma | API key |
268
+ | **OpenRouter** | 200+ models | API key |
269
+ | **Mistral AI** | Mistral Large, Codestral | API key |
270
+ | **DeepSeek** | DeepSeek-V3, DeepSeek-R1 | API key |
271
+ | **Together AI** | Llama 4, Qwen, Falcon | API key |
272
+ | **xAI** | Grok-2, Grok-2-vision | API key |
273
+ | **Cohere** | Command R+ | API key |
274
+ | **Ollama** | Any local model | Local |
275
+ | **LM Studio** | Any GGUF model | Local |
175
276
 
176
- ### COCO Methodology
277
+ Switch provider mid-session: `coco config set provider groq`
278
+
279
+ **[Provider guide + compatibility matrix โ†’](docs/guides/PROVIDERS.md)**
280
+
281
+ ---
282
+
283
+ ## Skills
284
+
285
+ Skills are reusable workflows committed to your repo. They're discovered automatically โ€” no registration step.
286
+
287
+ **Three scopes, one system:**
288
+
289
+ ```
290
+ ~/.coco/skills/ # your machine โ€” personal workflows
291
+ .coco/skills/ # this repo โ€” shared with the team
292
+ built-in # shipped with coco
293
+ ```
177
294
 
178
- Four phases for production-ready output:
295
+ **Using a skill:**
179
296
 
180
297
  ```
181
- CONVERGE ORCHESTRATE COMPLETE OUTPUT
182
- โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
183
- โ”‚ Gather โ”‚ โ”‚ Design โ”‚ โ”‚ Execute with โ”‚ โ”‚ Generate โ”‚
184
- โ”‚ reqs โ”‚ โ”€โ”€โ–บ โ”‚ architecture โ”‚โ”€โ”€โ–บโ”‚ quality โ”‚โ”€โ”€โ–บโ”‚ CI/CD, โ”‚
185
- โ”‚ + spec โ”‚ โ”‚ + backlog โ”‚ โ”‚ convergence โ”‚ โ”‚ docs โ”‚
186
- โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
187
- โ†‘ โ†“
188
- โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
189
- โ”‚ Convergence โ”‚
190
- โ”‚ Loop โ”‚
191
- โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
298
+ /ship # full release pipeline
299
+ /review # code review
300
+ /check # quality gate
192
301
  ```
193
302
 
194
- 1. **Converge** โ€” Understand requirements
195
- 2. **Orchestrate** โ€” Design architecture
196
- 3. **Complete** โ€” Build with quality iteration
197
- 4. **Output** โ€” Generate deployment config
303
+ **Creating a project skill** โ€” create `.coco/skills/deploy.md`:
198
304
 
305
+ ```markdown
306
+ ---
307
+ name: deploy
308
+ description: Deploy to staging and run smoke tests
199
309
  ---
200
310
 
201
- ## ๐Ÿ“– Documentation
311
+ Run `pnpm build`, then deploy to staging with `./scripts/deploy.sh staging`,
312
+ then hit the health endpoint and verify 200. Report any failures clearly.
313
+ ```
314
+
315
+ Now anyone on the team can type `/deploy`.
316
+
317
+ Skills support Markdown, YAML, and JSON. The skills system auto-reloads on change.
202
318
 
203
- - [Configuration Guide](docs/guides/CONFIGURATION.md)
204
- - [Quick Start Tutorial](docs/guides/QUICK_START.md)
205
- - [Troubleshooting](docs/guides/TROUBLESHOOTING.md)
206
- - [API Reference](docs/API.md)
207
- - [MCP Integration](docs/MCP.md)
319
+ **[Skills cookbook โ†’](docs/guides/COOKBOOK.md#skills)**
208
320
 
209
321
  ---
210
322
 
211
- ## ๐Ÿง‘โ€๐Ÿ’ป Development
323
+ ## MCP Integration
324
+
325
+ Connect Coco to any MCP-compatible server โ€” filesystem, databases, APIs, browser automation:
212
326
 
213
327
  ```bash
214
- git clone https://github.com/corbat/corbat-coco
215
- cd corbat-coco
216
- pnpm install
217
- pnpm dev # Run in dev mode
218
- pnpm test # 4,350+ tests
219
- pnpm check # Typecheck + lint + test
328
+ # Add the official filesystem server
329
+ coco mcp add filesystem \
330
+ --command "npx" \
331
+ --args "-y,@modelcontextprotocol/server-filesystem,/home/user"
332
+
333
+ # Add a database server
334
+ coco mcp add postgres \
335
+ --command "npx" \
336
+ --args "-y,@modelcontextprotocol/server-postgres" \
337
+ --env "DATABASE_URL=postgresql://..."
220
338
  ```
221
339
 
222
- ### Project Structure
340
+ Once connected, MCP tools are registered and available to the agent alongside built-in tools.
341
+
342
+ **[MCP guide โ†’](docs/MCP.md)**
343
+
344
+ ---
345
+
346
+ ## Configuration
223
347
 
348
+ ```bash
349
+ # Project config (committed to the repo)
350
+ cat .coco.config.json
351
+
352
+ # CLI config
353
+ coco config list
354
+ coco config set quality.minScore 90
355
+ coco config set provider deepseek
224
356
  ```
225
- src/
226
- โ”œโ”€โ”€ agents/ # Multi-agent coordination
227
- โ”œโ”€โ”€ cli/ # REPL + commands
228
- โ”œโ”€โ”€ phases/ # COCO phases
229
- โ”œโ”€โ”€ quality/ # 12-dimension scoring
230
- โ”œโ”€โ”€ providers/ # LLM provider integrations
231
- โ””โ”€โ”€ tools/ # File ops, git, tests, etc.
357
+
358
+ `.coco.config.json` example:
359
+
360
+ ```json
361
+ {
362
+ "name": "my-api",
363
+ "language": "typescript",
364
+ "quality": {
365
+ "minScore": 88,
366
+ "maxIterations": 8
367
+ }
368
+ }
232
369
  ```
233
370
 
234
- **Stack:** TypeScript + Node.js 22 + Vitest + oxlint/oxfmt + Zod
371
+ **[Configuration reference โ†’](docs/guides/CONFIGURATION.md)**
235
372
 
236
373
  ---
237
374
 
238
- ## ๐ŸŽ“ Use Cases
375
+ ## Multi-Agent Architecture
239
376
 
240
- - **Feature development** โ€” Get tested, reviewed code
241
- - **Refactoring** โ€” Improve quality with measurable progress
242
- - **Test generation** โ€” Meaningful tests, not boilerplate
243
- - **Code review** โ€” 12-dimensional quality feedback
244
- - **Learning** โ€” See how quality improves across iterations
377
+ Six specialized agents route automatically based on the task:
378
+
379
+ - **Researcher** โ€” codebase exploration, context gathering
380
+ - **Coder** โ€” implementation (default for most tasks)
381
+ - **Tester** โ€” test generation and coverage improvement
382
+ - **Reviewer** โ€” quality audits, security analysis
383
+ - **Optimizer** โ€” refactoring, performance improvements
384
+ - **Planner** โ€” architecture, task decomposition
385
+
386
+ For complex tasks, agents run in parallel where dependencies allow.
245
387
 
246
388
  ---
247
389
 
248
- ## โš ๏ธ Known Limitations
390
+ ## Documentation
391
+
392
+ | Guide | What's in it |
393
+ |-------|-------------|
394
+ | [Quick Start](docs/guides/QUICK_START.md) | Install, setup, first project |
395
+ | **[Cookbook & Examples](docs/guides/COOKBOOK.md)** | Prompting patterns, skills, MCP, daily workflows |
396
+ | [Configuration](docs/guides/CONFIGURATION.md) | Full config reference |
397
+ | [Providers](docs/guides/PROVIDERS.md) | Provider setup, compatibility, cost table |
398
+ | [Quality Guide](docs/guides/QUALITY.md) | 12-dimension analysis, language support, CI |
399
+ | [GitHub Actions](docs/guides/GITHUB-ACTIONS.md) | CI/CD integration, PR comments |
400
+ | [MCP Integration](docs/MCP.md) | Connecting external tools |
401
+ | [Architecture](docs/architecture/ARCHITECTURE.md) | System design, ADRs |
402
+ | [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common issues |
403
+
404
+ ---
405
+
406
+ ## Development
407
+
408
+ ```bash
409
+ git clone https://github.com/corbat-tech/coco
410
+ cd coco
411
+ pnpm install
412
+
413
+ pnpm dev # run with tsx (hot reload)
414
+ pnpm check # typecheck + lint + test
415
+ pnpm test # 5290 tests
416
+ pnpm format:fix # fix formatting
417
+ ```
418
+
419
+ **Stack:** TypeScript ยท Node.js 22 ยท Vitest ยท oxlint ยท oxfmt ยท Zod ยท Commander
420
+
421
+ ---
249
422
 
250
- We'd rather you know upfront:
423
+ ## Known Limitations
251
424
 
252
- - **TypeScript/JavaScript first** โ€” Other languages have basic support
253
- - **CLI-only** โ€” No IDE extension yet (VS Code planned)
254
- - **Iteration takes time** โ€” Convergence adds 2-5 min per task
255
- - **LLM-dependent** โ€” Quality depends on your model choice
256
- - **Early stage** โ€” Not yet battle-tested at enterprise scale
425
+ - **CLI only** โ€” no VS Code extension yet
426
+ - **Convergence takes time** โ€” expect 2โ€“5 min per task depending on complexity
427
+ - **Quality depends on the model** โ€” Claude Opus gives the best results; smaller models score lower
428
+ - **Not yet battle-tested at enterprise scale** โ€” production use at medium-scale projects, feedback welcome
257
429
 
258
430
  ---
259
431
 
260
- ## ๐Ÿค Contributing
432
+ ## Privacy
433
+
434
+ Coco sends your prompts and relevant code context to the LLM provider you configure. Your code is not stored by Coco and is not used to train models โ€” that is governed by each provider's own data policy:
435
+
436
+ - **Anthropic**: https://www.anthropic.com/privacy
437
+ - **OpenAI**: https://openai.com/policies/privacy-policy
438
+ - **Google Gemini**: https://policies.google.com/privacy
439
+ - **Local models** (Ollama, LM Studio): nothing leaves your machine
440
+
441
+ Coco does not collect telemetry. No usage data is sent to Corbat.
442
+
443
+ ---
261
444
 
262
- Contributions welcome:
445
+ ## Contributing
263
446
 
264
- - ๐Ÿ› Bug reports and feature requests
265
- - ๐Ÿ”ฌ New quality analyzers
266
- - ๐Ÿ”Œ Additional LLM providers
267
- - ๐Ÿ“š Documentation and examples
447
+ Contributions welcome โ€” especially new quality analyzers and providers.
268
448
 
269
- See [CONTRIBUTING.md](./CONTRIBUTING.md).
449
+ - Bug reports: [GitHub Issues](https://github.com/corbat-tech/coco/issues)
450
+ - See [CONTRIBUTING.md](./CONTRIBUTING.md) for the development workflow
270
451
 
271
452
  ---
272
453
 
273
- ## ๐Ÿ“„ License
454
+ ## License
274
455
 
275
456
  MIT ยฉ [Corbat](https://corbat.tech)
276
457
 
@@ -278,8 +459,8 @@ MIT ยฉ [Corbat](https://corbat.tech)
278
459
 
279
460
  <div align="center">
280
461
 
281
- **Built by developers who measure before they ship** ๐Ÿฅฅ
462
+ **Write the requirement. Coco does the rest.** ๐Ÿฅฅ
282
463
 
283
- [GitHub](https://github.com/corbat/corbat-coco) ยท [corbat.tech](https://corbat.tech) ยท [npm](https://www.npmjs.com/package/@corbat-tech/coco)
464
+ [npm](https://www.npmjs.com/package/@corbat-tech/coco) ยท [GitHub](https://github.com/corbat-tech/coco) ยท [corbat.tech](https://corbat.tech)
284
465
 
285
466
  </div>