codd-dev 0.2.0a1__tar.gz
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.
- codd_dev-0.2.0a1/.gitignore +26 -0
- codd_dev-0.2.0a1/LICENSE +21 -0
- codd_dev-0.2.0a1/PKG-INFO +241 -0
- codd_dev-0.2.0a1/README.md +214 -0
- codd_dev-0.2.0a1/codd/__init__.py +3 -0
- codd_dev-0.2.0a1/codd/cli.py +344 -0
- codd_dev-0.2.0a1/codd/config.py +62 -0
- codd_dev-0.2.0a1/codd/defaults.yaml +30 -0
- codd_dev-0.2.0a1/codd/generator.py +644 -0
- codd_dev-0.2.0a1/codd/graph.py +288 -0
- codd_dev-0.2.0a1/codd/hooks.py +104 -0
- codd_dev-0.2.0a1/codd/implementer.py +846 -0
- codd_dev-0.2.0a1/codd/planner.py +576 -0
- codd_dev-0.2.0a1/codd/propagate.py +308 -0
- codd_dev-0.2.0a1/codd/scanner.py +445 -0
- codd_dev-0.2.0a1/codd/validator.py +499 -0
- codd_dev-0.2.0a1/codd/verifier.py +426 -0
- codd_dev-0.2.0a1/hooks/pre-commit +10 -0
- codd_dev-0.2.0a1/pyproject.toml +56 -0
- codd_dev-0.2.0a1/templates/codd.yaml.tmpl +38 -0
- codd_dev-0.2.0a1/templates/conventions.yaml.tmpl +15 -0
- codd_dev-0.2.0a1/templates/data_dependencies.yaml.tmpl +12 -0
- codd_dev-0.2.0a1/templates/doc_links.yaml.tmpl +14 -0
- codd_dev-0.2.0a1/templates/gitignore.tmpl +11 -0
- codd_dev-0.2.0a1/templates/overrides.yaml.tmpl +13 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.pyc
|
|
4
|
+
*.pyo
|
|
5
|
+
*.egg-info/
|
|
6
|
+
dist/
|
|
7
|
+
build/
|
|
8
|
+
*.egg
|
|
9
|
+
|
|
10
|
+
# Virtual environments
|
|
11
|
+
.venv/
|
|
12
|
+
venv/
|
|
13
|
+
|
|
14
|
+
# IDE
|
|
15
|
+
.idea/
|
|
16
|
+
.vscode/
|
|
17
|
+
*.swp
|
|
18
|
+
|
|
19
|
+
# Test
|
|
20
|
+
.coverage
|
|
21
|
+
htmlcov/
|
|
22
|
+
.pytest_cache/
|
|
23
|
+
|
|
24
|
+
# CoDD generated (for development/testing)
|
|
25
|
+
codd/graph.db
|
|
26
|
+
codd/reports/
|
codd_dev-0.2.0a1/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 oshio
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,241 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: codd-dev
|
|
3
|
+
Version: 0.2.0a1
|
|
4
|
+
Summary: CoDD: Coherence-Driven Development — cross-artifact change impact analysis
|
|
5
|
+
Project-URL: Homepage, https://github.com/yohey-w/shogun-codd
|
|
6
|
+
Project-URL: Repository, https://github.com/yohey-w/shogun-codd
|
|
7
|
+
Project-URL: Issues, https://github.com/yohey-w/shogun-codd/issues
|
|
8
|
+
Author-email: Yohei Watanabe <yohey-w@users.noreply.github.com>
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: change-impact,claude-code,dependency-graph,plugin,software-engineering
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
17
|
+
Requires-Python: >=3.10
|
|
18
|
+
Requires-Dist: click>=8.0
|
|
19
|
+
Requires-Dist: pyyaml>=6.0
|
|
20
|
+
Provides-Extra: mcp
|
|
21
|
+
Provides-Extra: scan
|
|
22
|
+
Requires-Dist: tree-sitter-java>=0.22; extra == 'scan'
|
|
23
|
+
Requires-Dist: tree-sitter-python>=0.22; extra == 'scan'
|
|
24
|
+
Requires-Dist: tree-sitter-typescript>=0.22; extra == 'scan'
|
|
25
|
+
Requires-Dist: tree-sitter>=0.22; extra == 'scan'
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# CoDD — Coherence-Driven Development
|
|
29
|
+
|
|
30
|
+
**CoDD keeps AI-built systems coherent as requirements change.**
|
|
31
|
+
|
|
32
|
+
Give CoDD your requirements and constraints. AI generates the design top-down, derives implementation and test strategy from those artifacts, and traces change impact across a dependency graph — so nothing falls out of sync.
|
|
33
|
+
|
|
34
|
+
> *Harnesses tell agents how to work. CoDD keeps artifacts coherent.*
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
Harness (CLAUDE.md, AGENTS.md, Hooks, Skills) ← Rules, guardrails, flow
|
|
38
|
+
└─ CoDD (methodology) ← Operates on the harness flow
|
|
39
|
+
└─ Design docs (docs/*.md) ← Artifacts CoDD generates and maintains
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
**Public Alpha** — `pip install codd-dev` — init / scan / impact / validate are stable today.
|
|
43
|
+
|
|
44
|
+
## The Problem
|
|
45
|
+
|
|
46
|
+
AI can generate code from specs. But what happens when requirements change mid-project?
|
|
47
|
+
|
|
48
|
+
- Which design docs are affected?
|
|
49
|
+
- Which tests need updating?
|
|
50
|
+
- Which API contracts broke?
|
|
51
|
+
- Did anyone forget to update the database migration?
|
|
52
|
+
|
|
53
|
+
Spec-driven tools help you write specs first. They don't track what happens when those specs change. That's where CoDD comes in.
|
|
54
|
+
|
|
55
|
+
### Why not just AGENTS.md or hooks?
|
|
56
|
+
|
|
57
|
+
AGENTS.md, CLAUDE.md, and hooks are **harness infrastructure** — they tell agents how to behave. CoDD is a **coherence layer** that sits on top of any harness and keeps design artifacts, implementation, and tests in sync when requirements change. CoDD is harness-agnostic: it works with Claude Code, GitHub Copilot, Cursor, or any agent framework.
|
|
58
|
+
|
|
59
|
+
## Core Principle: Derive, Don't Configure
|
|
60
|
+
|
|
61
|
+
**Upstream artifacts + best practices = downstream is self-evident.**
|
|
62
|
+
|
|
63
|
+
- `system_design.md` says "Next.js + Supabase" → test strategy is vitest + Playwright. No config needed.
|
|
64
|
+
- `api_design.md` says "FastAPI" → pytest + httpx. No config needed.
|
|
65
|
+
- Requirements change → `codd impact` shows exactly what's affected.
|
|
66
|
+
|
|
67
|
+
You define requirements and constraints. AI derives everything else.
|
|
68
|
+
|
|
69
|
+
## How It Works
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
Phase 1: Requirements (human) ─┐
|
|
73
|
+
Phase 2: Design generation (AI) │ V-Model left side
|
|
74
|
+
Phase 3: Scan (auto) │
|
|
75
|
+
Phase 4: Implementation (AI) ─┘
|
|
76
|
+
Phase 5: Verification (AI + human) ─── V-Model right side
|
|
77
|
+
Phase 6: Change impact analysis ─┐
|
|
78
|
+
Phase 7: Change propagation │ Continuous coherence
|
|
79
|
+
Phase 8: Customer review ─┘
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Design docs are generated in **Wave order** — each wave depends on the previous:
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
Wave 1: Acceptance criteria + ADR (← requirements only)
|
|
86
|
+
Wave 2: System design (← req + Wave 1)
|
|
87
|
+
Wave 3: Database design + API design (← req + Wave 1-2)
|
|
88
|
+
Wave 4: UI/UX design (← req + Wave 1-3)
|
|
89
|
+
Wave 5: Implementation plan (← all above)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Verification runs bottom-up (IPA Common Frame):
|
|
93
|
+
```
|
|
94
|
+
Unit tests ← verifies detailed design
|
|
95
|
+
Integration ← verifies system design
|
|
96
|
+
E2E / System ← verifies requirements + acceptance criteria
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Three Layers (Don't Confuse Them)
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
Harness (CLAUDE.md, Hooks, Skills) ← Rules, guardrails, flow
|
|
103
|
+
└─ CoDD (methodology) ← Operates on the harness flow
|
|
104
|
+
└─ Design docs (docs/*.md) ← Artifacts CoDD generates and maintains
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
- **Harness** = how agents work (any harness: Claude Code, Copilot, Cursor, etc.)
|
|
108
|
+
- **CoDD** = how artifacts stay coherent across changes
|
|
109
|
+
- **Docs** = what CoDD produces and maintains
|
|
110
|
+
|
|
111
|
+
CoDD is **harness-agnostic**. It runs on top of whatever agent framework you use.
|
|
112
|
+
|
|
113
|
+
## Quick Start
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# Install
|
|
117
|
+
pip install codd-dev
|
|
118
|
+
|
|
119
|
+
# Initialize
|
|
120
|
+
codd init --project-name "my-project" --language "typescript"
|
|
121
|
+
|
|
122
|
+
# Scan — build dependency graph from frontmatter
|
|
123
|
+
codd scan
|
|
124
|
+
|
|
125
|
+
# Impact — what breaks if I change this?
|
|
126
|
+
codd impact --diff HEAD~1
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Real Project: Osato LMS
|
|
130
|
+
|
|
131
|
+
CoDD was dogfooded on a production LMS (Learning Management System). All design documents, implementation code, and tests were generated by AI following CoDD's workflow. No manual review by the client.
|
|
132
|
+
|
|
133
|
+
```
|
|
134
|
+
docs/
|
|
135
|
+
├── requirements/ # What to build (client agreement, SSoT)
|
|
136
|
+
├── design/ # How to build it (system design, API, DB, UI)
|
|
137
|
+
├── detailed_design/ # Module-level specs
|
|
138
|
+
├── plan/ # WBS, schedule, RACI
|
|
139
|
+
├── governance/ # ADR, meeting minutes, change requests
|
|
140
|
+
├── test/ # Acceptance criteria, test plans
|
|
141
|
+
├── operations/ # Runbooks, monitoring design
|
|
142
|
+
└── infra/ # Infrastructure specs
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Every doc has CoDD frontmatter declaring its dependencies:
|
|
146
|
+
|
|
147
|
+
```yaml
|
|
148
|
+
---
|
|
149
|
+
codd:
|
|
150
|
+
node_id: "design:api-design"
|
|
151
|
+
depends_on:
|
|
152
|
+
- id: "design:system-design"
|
|
153
|
+
relation: derives_from
|
|
154
|
+
- id: "req:lms-requirements-v2.0"
|
|
155
|
+
relation: implements
|
|
156
|
+
---
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
When the requirements changed mid-project, `codd impact` identified exactly which design docs, API endpoints, and test cases needed updating — and AI fixed them automatically.
|
|
160
|
+
|
|
161
|
+
## How CoDD Differs from Spec Kit / OpenSpec
|
|
162
|
+
|
|
163
|
+
| | Spec Kit | OpenSpec | **CoDD** |
|
|
164
|
+
|--|----------|---------|----------|
|
|
165
|
+
| Write specs first | Yes | Yes | Yes |
|
|
166
|
+
| AI generates code from specs | Yes | Yes | Yes |
|
|
167
|
+
| **Change propagation** | No | No | **Dependency graph + impact analysis** |
|
|
168
|
+
| **Derive test strategy from architecture** | No | No | **Automatic (derive, don't configure)** |
|
|
169
|
+
| **V-Model verification** | No | No | **Unit → Integration → E2E** |
|
|
170
|
+
| **Impact analysis on change** | No | No | **codd impact --diff HEAD~1** |
|
|
171
|
+
| Harness-agnostic | GitHub Copilot focused | Multi-agent | **Any harness** |
|
|
172
|
+
|
|
173
|
+
**Spec Kit and OpenSpec answer "how do I start?" CoDD answers "how do I keep going when things change?"**
|
|
174
|
+
|
|
175
|
+
## What's Available Now (v0.2.0-alpha.1)
|
|
176
|
+
|
|
177
|
+
| Command | Status | What it does |
|
|
178
|
+
|---------|--------|-------------|
|
|
179
|
+
| `codd init` | **Stable** | Initialize CoDD in any project |
|
|
180
|
+
| `codd scan` | **Stable** | Build dependency graph from frontmatter |
|
|
181
|
+
| `codd impact` | **Stable** | Analyze change impact (Green/Amber/Gray bands) |
|
|
182
|
+
| `codd validate` | **Alpha** | Check frontmatter integrity and graph consistency |
|
|
183
|
+
| `codd generate` | Experimental | Generate design docs in Wave order |
|
|
184
|
+
| `codd plan` | Experimental | Wave execution status and auto-initialization |
|
|
185
|
+
| `codd verify` | Experimental | V-Model verification (typecheck + tests → design tracing) |
|
|
186
|
+
| `codd implement` | Experimental | Design-to-code generation |
|
|
187
|
+
|
|
188
|
+
### Alpha Scope: What We Promise / What We Don't
|
|
189
|
+
|
|
190
|
+
| We promise | We don't promise (yet) |
|
|
191
|
+
|------------|----------------------|
|
|
192
|
+
| Frontmatter-based dependency graph works | Full semantic dependency types beyond Wave order |
|
|
193
|
+
| `codd impact` correctly identifies affected nodes | Automatic fix of affected nodes |
|
|
194
|
+
| `codd validate` catches broken references and cycles | Exhaustive validation of all edge cases |
|
|
195
|
+
| Harness-agnostic (no vendor lock-in) | Turnkey integrations for every harness |
|
|
196
|
+
| Derivation principle: architecture → test strategy | Fully automated end-to-end generation pipeline |
|
|
197
|
+
| MIT license, stable CLI interface for core commands | API stability for experimental commands |
|
|
198
|
+
|
|
199
|
+
## Frontmatter is the Single Source of Truth
|
|
200
|
+
|
|
201
|
+
CoDD uses YAML frontmatter in Markdown files to declare dependencies. `graph.db` is a derived cache — regenerated on every `codd scan`. No separate config files to maintain.
|
|
202
|
+
|
|
203
|
+
```yaml
|
|
204
|
+
---
|
|
205
|
+
codd:
|
|
206
|
+
node_id: "design:system-design"
|
|
207
|
+
type: design
|
|
208
|
+
depends_on:
|
|
209
|
+
- id: "req:lms-requirements-v2.0"
|
|
210
|
+
relation: implements
|
|
211
|
+
conventions:
|
|
212
|
+
- targets: ["db:rls_policies"]
|
|
213
|
+
reason: "Tenant isolation is non-negotiable"
|
|
214
|
+
---
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## Real-World Example: Derive, Don't Configure
|
|
218
|
+
|
|
219
|
+
```
|
|
220
|
+
system_design.md says "Next.js + Supabase"
|
|
221
|
+
→ Test strategy: vitest (unit) + Playwright (E2E). No config needed.
|
|
222
|
+
|
|
223
|
+
system_design.md says "FastAPI + Python"
|
|
224
|
+
→ Test strategy: pytest (unit/integration) + httpx (API). No config needed.
|
|
225
|
+
|
|
226
|
+
system_design.md says "CLI tool in Go"
|
|
227
|
+
→ Test strategy: go test (unit/integration). No config needed.
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
The architecture determines the test strategy. CoDD derives it — you don't configure it.
|
|
231
|
+
|
|
232
|
+
## Roadmap
|
|
233
|
+
|
|
234
|
+
- [ ] Semantic dependency types (requires, affects, verifies, implements)
|
|
235
|
+
- [ ] `codd verify` — full docs ↔ code ↔ tests coherence check
|
|
236
|
+
- [ ] Multi-agent integration examples (Claude Code, Copilot, Cursor)
|
|
237
|
+
- [ ] VS Code extension for impact visualization
|
|
238
|
+
|
|
239
|
+
## License
|
|
240
|
+
|
|
241
|
+
MIT
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# CoDD — Coherence-Driven Development
|
|
2
|
+
|
|
3
|
+
**CoDD keeps AI-built systems coherent as requirements change.**
|
|
4
|
+
|
|
5
|
+
Give CoDD your requirements and constraints. AI generates the design top-down, derives implementation and test strategy from those artifacts, and traces change impact across a dependency graph — so nothing falls out of sync.
|
|
6
|
+
|
|
7
|
+
> *Harnesses tell agents how to work. CoDD keeps artifacts coherent.*
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
Harness (CLAUDE.md, AGENTS.md, Hooks, Skills) ← Rules, guardrails, flow
|
|
11
|
+
└─ CoDD (methodology) ← Operates on the harness flow
|
|
12
|
+
└─ Design docs (docs/*.md) ← Artifacts CoDD generates and maintains
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**Public Alpha** — `pip install codd-dev` — init / scan / impact / validate are stable today.
|
|
16
|
+
|
|
17
|
+
## The Problem
|
|
18
|
+
|
|
19
|
+
AI can generate code from specs. But what happens when requirements change mid-project?
|
|
20
|
+
|
|
21
|
+
- Which design docs are affected?
|
|
22
|
+
- Which tests need updating?
|
|
23
|
+
- Which API contracts broke?
|
|
24
|
+
- Did anyone forget to update the database migration?
|
|
25
|
+
|
|
26
|
+
Spec-driven tools help you write specs first. They don't track what happens when those specs change. That's where CoDD comes in.
|
|
27
|
+
|
|
28
|
+
### Why not just AGENTS.md or hooks?
|
|
29
|
+
|
|
30
|
+
AGENTS.md, CLAUDE.md, and hooks are **harness infrastructure** — they tell agents how to behave. CoDD is a **coherence layer** that sits on top of any harness and keeps design artifacts, implementation, and tests in sync when requirements change. CoDD is harness-agnostic: it works with Claude Code, GitHub Copilot, Cursor, or any agent framework.
|
|
31
|
+
|
|
32
|
+
## Core Principle: Derive, Don't Configure
|
|
33
|
+
|
|
34
|
+
**Upstream artifacts + best practices = downstream is self-evident.**
|
|
35
|
+
|
|
36
|
+
- `system_design.md` says "Next.js + Supabase" → test strategy is vitest + Playwright. No config needed.
|
|
37
|
+
- `api_design.md` says "FastAPI" → pytest + httpx. No config needed.
|
|
38
|
+
- Requirements change → `codd impact` shows exactly what's affected.
|
|
39
|
+
|
|
40
|
+
You define requirements and constraints. AI derives everything else.
|
|
41
|
+
|
|
42
|
+
## How It Works
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
Phase 1: Requirements (human) ─┐
|
|
46
|
+
Phase 2: Design generation (AI) │ V-Model left side
|
|
47
|
+
Phase 3: Scan (auto) │
|
|
48
|
+
Phase 4: Implementation (AI) ─┘
|
|
49
|
+
Phase 5: Verification (AI + human) ─── V-Model right side
|
|
50
|
+
Phase 6: Change impact analysis ─┐
|
|
51
|
+
Phase 7: Change propagation │ Continuous coherence
|
|
52
|
+
Phase 8: Customer review ─┘
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Design docs are generated in **Wave order** — each wave depends on the previous:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
Wave 1: Acceptance criteria + ADR (← requirements only)
|
|
59
|
+
Wave 2: System design (← req + Wave 1)
|
|
60
|
+
Wave 3: Database design + API design (← req + Wave 1-2)
|
|
61
|
+
Wave 4: UI/UX design (← req + Wave 1-3)
|
|
62
|
+
Wave 5: Implementation plan (← all above)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Verification runs bottom-up (IPA Common Frame):
|
|
66
|
+
```
|
|
67
|
+
Unit tests ← verifies detailed design
|
|
68
|
+
Integration ← verifies system design
|
|
69
|
+
E2E / System ← verifies requirements + acceptance criteria
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Three Layers (Don't Confuse Them)
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
Harness (CLAUDE.md, Hooks, Skills) ← Rules, guardrails, flow
|
|
76
|
+
└─ CoDD (methodology) ← Operates on the harness flow
|
|
77
|
+
└─ Design docs (docs/*.md) ← Artifacts CoDD generates and maintains
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
- **Harness** = how agents work (any harness: Claude Code, Copilot, Cursor, etc.)
|
|
81
|
+
- **CoDD** = how artifacts stay coherent across changes
|
|
82
|
+
- **Docs** = what CoDD produces and maintains
|
|
83
|
+
|
|
84
|
+
CoDD is **harness-agnostic**. It runs on top of whatever agent framework you use.
|
|
85
|
+
|
|
86
|
+
## Quick Start
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Install
|
|
90
|
+
pip install codd-dev
|
|
91
|
+
|
|
92
|
+
# Initialize
|
|
93
|
+
codd init --project-name "my-project" --language "typescript"
|
|
94
|
+
|
|
95
|
+
# Scan — build dependency graph from frontmatter
|
|
96
|
+
codd scan
|
|
97
|
+
|
|
98
|
+
# Impact — what breaks if I change this?
|
|
99
|
+
codd impact --diff HEAD~1
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Real Project: Osato LMS
|
|
103
|
+
|
|
104
|
+
CoDD was dogfooded on a production LMS (Learning Management System). All design documents, implementation code, and tests were generated by AI following CoDD's workflow. No manual review by the client.
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
docs/
|
|
108
|
+
├── requirements/ # What to build (client agreement, SSoT)
|
|
109
|
+
├── design/ # How to build it (system design, API, DB, UI)
|
|
110
|
+
├── detailed_design/ # Module-level specs
|
|
111
|
+
├── plan/ # WBS, schedule, RACI
|
|
112
|
+
├── governance/ # ADR, meeting minutes, change requests
|
|
113
|
+
├── test/ # Acceptance criteria, test plans
|
|
114
|
+
├── operations/ # Runbooks, monitoring design
|
|
115
|
+
└── infra/ # Infrastructure specs
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Every doc has CoDD frontmatter declaring its dependencies:
|
|
119
|
+
|
|
120
|
+
```yaml
|
|
121
|
+
---
|
|
122
|
+
codd:
|
|
123
|
+
node_id: "design:api-design"
|
|
124
|
+
depends_on:
|
|
125
|
+
- id: "design:system-design"
|
|
126
|
+
relation: derives_from
|
|
127
|
+
- id: "req:lms-requirements-v2.0"
|
|
128
|
+
relation: implements
|
|
129
|
+
---
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
When the requirements changed mid-project, `codd impact` identified exactly which design docs, API endpoints, and test cases needed updating — and AI fixed them automatically.
|
|
133
|
+
|
|
134
|
+
## How CoDD Differs from Spec Kit / OpenSpec
|
|
135
|
+
|
|
136
|
+
| | Spec Kit | OpenSpec | **CoDD** |
|
|
137
|
+
|--|----------|---------|----------|
|
|
138
|
+
| Write specs first | Yes | Yes | Yes |
|
|
139
|
+
| AI generates code from specs | Yes | Yes | Yes |
|
|
140
|
+
| **Change propagation** | No | No | **Dependency graph + impact analysis** |
|
|
141
|
+
| **Derive test strategy from architecture** | No | No | **Automatic (derive, don't configure)** |
|
|
142
|
+
| **V-Model verification** | No | No | **Unit → Integration → E2E** |
|
|
143
|
+
| **Impact analysis on change** | No | No | **codd impact --diff HEAD~1** |
|
|
144
|
+
| Harness-agnostic | GitHub Copilot focused | Multi-agent | **Any harness** |
|
|
145
|
+
|
|
146
|
+
**Spec Kit and OpenSpec answer "how do I start?" CoDD answers "how do I keep going when things change?"**
|
|
147
|
+
|
|
148
|
+
## What's Available Now (v0.2.0-alpha.1)
|
|
149
|
+
|
|
150
|
+
| Command | Status | What it does |
|
|
151
|
+
|---------|--------|-------------|
|
|
152
|
+
| `codd init` | **Stable** | Initialize CoDD in any project |
|
|
153
|
+
| `codd scan` | **Stable** | Build dependency graph from frontmatter |
|
|
154
|
+
| `codd impact` | **Stable** | Analyze change impact (Green/Amber/Gray bands) |
|
|
155
|
+
| `codd validate` | **Alpha** | Check frontmatter integrity and graph consistency |
|
|
156
|
+
| `codd generate` | Experimental | Generate design docs in Wave order |
|
|
157
|
+
| `codd plan` | Experimental | Wave execution status and auto-initialization |
|
|
158
|
+
| `codd verify` | Experimental | V-Model verification (typecheck + tests → design tracing) |
|
|
159
|
+
| `codd implement` | Experimental | Design-to-code generation |
|
|
160
|
+
|
|
161
|
+
### Alpha Scope: What We Promise / What We Don't
|
|
162
|
+
|
|
163
|
+
| We promise | We don't promise (yet) |
|
|
164
|
+
|------------|----------------------|
|
|
165
|
+
| Frontmatter-based dependency graph works | Full semantic dependency types beyond Wave order |
|
|
166
|
+
| `codd impact` correctly identifies affected nodes | Automatic fix of affected nodes |
|
|
167
|
+
| `codd validate` catches broken references and cycles | Exhaustive validation of all edge cases |
|
|
168
|
+
| Harness-agnostic (no vendor lock-in) | Turnkey integrations for every harness |
|
|
169
|
+
| Derivation principle: architecture → test strategy | Fully automated end-to-end generation pipeline |
|
|
170
|
+
| MIT license, stable CLI interface for core commands | API stability for experimental commands |
|
|
171
|
+
|
|
172
|
+
## Frontmatter is the Single Source of Truth
|
|
173
|
+
|
|
174
|
+
CoDD uses YAML frontmatter in Markdown files to declare dependencies. `graph.db` is a derived cache — regenerated on every `codd scan`. No separate config files to maintain.
|
|
175
|
+
|
|
176
|
+
```yaml
|
|
177
|
+
---
|
|
178
|
+
codd:
|
|
179
|
+
node_id: "design:system-design"
|
|
180
|
+
type: design
|
|
181
|
+
depends_on:
|
|
182
|
+
- id: "req:lms-requirements-v2.0"
|
|
183
|
+
relation: implements
|
|
184
|
+
conventions:
|
|
185
|
+
- targets: ["db:rls_policies"]
|
|
186
|
+
reason: "Tenant isolation is non-negotiable"
|
|
187
|
+
---
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## Real-World Example: Derive, Don't Configure
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
system_design.md says "Next.js + Supabase"
|
|
194
|
+
→ Test strategy: vitest (unit) + Playwright (E2E). No config needed.
|
|
195
|
+
|
|
196
|
+
system_design.md says "FastAPI + Python"
|
|
197
|
+
→ Test strategy: pytest (unit/integration) + httpx (API). No config needed.
|
|
198
|
+
|
|
199
|
+
system_design.md says "CLI tool in Go"
|
|
200
|
+
→ Test strategy: go test (unit/integration). No config needed.
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
The architecture determines the test strategy. CoDD derives it — you don't configure it.
|
|
204
|
+
|
|
205
|
+
## Roadmap
|
|
206
|
+
|
|
207
|
+
- [ ] Semantic dependency types (requires, affects, verifies, implements)
|
|
208
|
+
- [ ] `codd verify` — full docs ↔ code ↔ tests coherence check
|
|
209
|
+
- [ ] Multi-agent integration examples (Claude Code, Copilot, Cursor)
|
|
210
|
+
- [ ] VS Code extension for impact visualization
|
|
211
|
+
|
|
212
|
+
## License
|
|
213
|
+
|
|
214
|
+
MIT
|