Skip to content

Commit 4e1535f

Browse files
committed
docs: update readme content and remove docs from gitignore
Update README with improved formatting, updated statistics, and added comparison table Remove docs directory from gitignore as documentation is now tracked
1 parent 6986d41 commit 4e1535f

File tree

3 files changed

+1672
-14
lines changed

3 files changed

+1672
-14
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ dist/
33
coverage/
44
.DS_Store
55
reports/
6-
docs/*
76

87
# Ignore specific dotfiles/folders
98
.codemachine

README.md

Lines changed: 89 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
1-
<h3 align="center">
1+
2+
<p align="center">
23
<code>npm i -g codemachine</code>
3-
</h3>
4+
</p>
5+
46

57
<p align="center">
68
<strong>CodeMachine CLI</strong> is an autonomous multi-agent platform that works locally on your computer, turning specifications into production-ready code.<br></p>
79

8-
> ### **✨ CodeMachine Built Itself**
9-
>
10-
> **90% of this entire codebase was generated by CodeMachine from a single specification file.**
11-
> This isn't a demo—it's proof. CodeMachine orchestrated its own architecture, planning, implementation, and testing—creating a massively scalable codebase ready for continuous updates and improvements.
12-
1310
<p align="center">
1411
<img src="assets/images/codemachine-demo.gif" alt="CodeMachine in Action" width="800">
1512
</p>
1613

14+
15+
<p align="center">
16+
<strong>✨ CodeMachine Built Itself</strong>
17+
</p>
18+
19+
<p align="center">
20+
<strong>90% of this entire codebase was generated by CodeMachine from a single specification file.</strong><br>
21+
This isn't a demo—it's proof. CodeMachine engine orchestrated its own architecture, planning, implementation, and testing—creating a massively scalable codebase ready for continuous updates and improvements.
22+
</p>
23+
24+
1725
---
1826

19-
## **What is CodeMachine?**
27+
**What is CodeMachine?**
2028

2129
CodeMachine is a CLI-native orchestration platform that transforms specification files and contextual inputs into production-ready code through coordinated multi-agent workflows. Specialized AI agents operate in hierarchical and parallel configurations with the ability for bidirectional communication, enabling runtime-adaptable methodologies that dynamically adjust to project requirements without framework modifications.
2230

@@ -105,28 +113,96 @@ CodeMachine requires at least one CLI-based AI engine to handle the primary role
105113

106114
## **Production Validation:**
107115

108-
CodeMachine has been battle-tested on the Sustaina Platform a full-stack ESG compliance system spanning **7 microservices**, **500+ files**, and **50,000+ lines of code** across Python, TypeScript, React, FastAPI, and NestJS.
116+
CodeMachine has been battle-tested on the Sustaina Platform a full-stack ESG compliance system spanning **7 microservices**, **500+ files**, and **60,000+ lines of code** across Python, TypeScript, React, FastAPI, and NestJS.
109117

110-
<table>
118+
<table align="center">
111119
<tr>
112120
<td><strong>Services Generated</strong></td>
113121
<td>7 microservices (AI/ML + CRUD APIs)</td>
114122
</tr>
115123
<tr>
116124
<td><strong>Codebase Scale</strong></td>
117-
<td>~500 files, 50K+ Line of code</td>
125+
<td>~500 files, 60K+ Line of code</td>
118126
</tr>
119127
<tr>
120128
<td><strong>Tech Stack</strong></td>
121129
<td>React 18, FastAPI, NestJS, PostgreSQL, MongoDB, Redis, Kubernetes</td>
122130
</tr>
123131
<tr>
124132
<td><strong>Time to MVP</strong></td>
125-
<td>~6 raw hours of autonomous orchestration</td>
133+
<td>~8 hours of autonomous orchestration</td>
126134
</tr>
127135
</table>
128136

129-
### [View detailed breakdown →](./docs/case-study-sustaina.md)
137+
### **CodeMachine vs Regular AI Agents**
138+
139+
We conducted a real-world comparison by monitoring development work on a project of identical scope and complexity using the most powerful AI agent tools (Claude Code, Cursor, Copilot) with manual orchestration and human review, versus CodeMachine's autonomous multi-agent orchestration.
140+
141+
<table align="center">
142+
<tr>
143+
<th><strong>Aspect</strong></th>
144+
<th><strong>Regular AI Agents</strong><br/>(Manual Orchestration + Human Review)</th>
145+
<th><strong>CodeMachine</strong><br/>(Autonomous Orchestration)</th>
146+
</tr>
147+
<tr>
148+
<td><strong>Architecture Planning</strong></td>
149+
<td>4-6 hours of manual prompting</td>
150+
<td>Automated (30 min)</td>
151+
</tr>
152+
<tr>
153+
<td><strong>Service Implementation</strong></td>
154+
<td>140-200 hours (7 services × 20-30h each)<br/>Manual prompting, context switching</td>
155+
<td>Parallel execution (5 hours)</td>
156+
</tr>
157+
<tr>
158+
<td><strong>Integration & Testing</strong></td>
159+
<td>30-50 hours<br/>Manual coordination, debugging</td>
160+
<td>Automated validation (2 hours)</td>
161+
</tr>
162+
<tr>
163+
<td><strong>Deployment Setup</strong></td>
164+
<td>8-12 hours<br/>Scripts, configs, orchestration</td>
165+
<td>Auto-generated (30 min)</td>
166+
</tr>
167+
<tr>
168+
<td><strong>Code Consistency</strong></td>
169+
<td>Inconsistent patterns across services<br/>Different coding styles per session</td>
170+
<td>Unified architecture & patterns<br/>Consistent across all components</td>
171+
</tr>
172+
<tr>
173+
<td><strong>Quality Control</strong></td>
174+
<td>Manual review required<br/>Errors compound over time</td>
175+
<td>Built-in validation at each step<br/>Automated sanity checks</td>
176+
</tr>
177+
<tr>
178+
<td><strong>Context Retention</strong></td>
179+
<td>Lost between sessions<br/>Repeated explanations needed</td>
180+
<td>Full project context maintained<br/>Cross-service awareness</td>
181+
</tr>
182+
<tr>
183+
<td><strong>Total Developer Time</strong></td>
184+
<td><strong>~200-300 hours</strong></td>
185+
<td><strong>~8 hours</strong></td>
186+
</tr>
187+
<tr>
188+
<td><strong>Efficiency Gain</strong></td>
189+
<td>Baseline</td>
190+
<td><strong>25-37× faster</strong></td>
191+
</tr>
192+
</table>
193+
194+
<p align="center"><em>Real-world comparison: One developer manually prompting AI coding assistants vs CodeMachine's autonomous multi-agent orchestration</em></p>
195+
196+
---
197+
198+
<p align="center">
199+
<strong>Want to see how CodeMachine built this?</strong><br/>
200+
Explore the complete case study showing the detailed path CodeMachine took to create this project—every step, decision, and workflow tracked from specification to production.
201+
</p>
202+
203+
<p align="center">
204+
<a href="./docs/case-study-sustaina.md"><strong>📊 View Complete Case Study & Development Track →</strong></a>
205+
</p>
130206

131207
---
132208

0 commit comments

Comments
 (0)