Skip to content

Commit 011e95d

Browse files
committed
temp return readme
1 parent c4856a3 commit 011e95d

1 file changed

Lines changed: 128 additions & 120 deletions

File tree

README.md

Lines changed: 128 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -7,135 +7,71 @@
77
</p>
88

99
<p align="center">
10-
<img src="./docs/assets/nova-banner.png" alt="v0.8 Nova Edition" width="400">
11-
</p>
10+
<strong>CodeMachine</strong> is a CLI-native Orchestration Engine that runs coordinated multi-agent workflows directly on your local machine. It provides the runtime infrastructure to execute complex multi-agent topologies within your own environment. Designed to drive any high-level autonomous objective, it features a battle-tested Spec-to-Code blueprint—transforming your terminal into a factory for production-ready software. ⚡️<br></p>
1211

1312
<p align="center">
14-
<strong>🌟 v0.8 NOVA EDITION is here - a massive update.</strong><br>
15-
New architecture, breaking changes, and a completely refreshed experience.<br>
16-
<a href="./docs/changelog.md">See what's changed →</a>
13+
<img src="https://raw.githubusercontent.com/moazbuilds/CodeMachine-CLI/main/docs/assets/demo.gif" alt="CodeMachine in Action" width="800">
1714
</p>
1815

19-
---
2016

2117
<p align="center">
22-
<strong>CodeMachine</strong> is a reliable, CLI-native orchestration platform built on coding agents that lets you turn complex coding objectives into repeatable, automated pipelines - with context engineering tools and agent observability - so you can build a workflow once and run it confidently on demand. ⚡️<br></p>
18+
<strong>✨ CodeMachine Built Itself</strong>
19+
</p>
2320

2421
<p align="center">
25-
<img src="https://raw.githubusercontent.com/moazbuilds/CodeMachine-CLI/main/docs/assets/demo.gif" alt="CodeMachine in Action" width="800">
22+
<strong>90% of this entire codebase was generated by CodeMachine from a single specification file.</strong><br>
23+
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.
2624
</p>
2725

28-
2926
---
3027

31-
**Coding agents are powerful - until the objectives get repetitive.**
32-
33-
When you're doing the same complex workflow for the 10th time - manually chaining sessions, managing context, rebuilding patterns - you become the bottleneck.
34-
35-
CodeMachine doesn't replace your agents. It orchestrates them.
28+
> **⚠️ Early Development Notice:** This project is in early development and is not yet ready for production use. Features may change, break, or be incomplete.
3629
37-
## Is CodeMachine For You?
38-
39-
**When CodeMachine makes sense:**
40-
- You're doing similar complex workflows repeatedly
41-
- Context management across long objectives is painful
42-
- You want to define once, run many times
43-
- Your team needs consistent, reproducible processes
30+
<p align="center">
31+
<a href="https://discord.gg/vS3A5UDNSq">
32+
<img src="https://raw.githubusercontent.com/moazbuilds/CodeMachine-CLI/main/docs/assets/discord-badge.png" alt="Join our Discord" width="200">
33+
</a>
34+
&nbsp;&nbsp;
35+
<a href="https://www.reddit.com/r/CodeMachine/">
36+
<img src="https://raw.githubusercontent.com/moazbuilds/CodeMachine-CLI/main/docs/assets/reddit-badge.png" alt="Join our Reddit" width="200">
37+
</a><br>
38+
<sub>Join our growing Discord and Reddit communities of developers building with CodeMachine!</sub>
39+
</p>
4440

45-
**When it doesn't:**
46-
- One-off tasks - your coding agent handles those perfectly
47-
- One-time fixes with no repeating pattern
48-
- You prefer manual control of session-by-session work
41+
## Why CodeMachine?
4942

43+
* **Customizable, End-to-End Workflows:** Architect sophisticated orchestration pipelines for any scale, from executing simple scripts to managing multi-day, complex development cycles.
44+
* **Strategic Multi-Agent Collaboration:** Leverage a heterogeneous multi-agent system by assigning specialized models to specific tasks—for instance, using Gemini for planning, Claude for implementation, and another model for code review.
45+
* **Massively Parallel Execution:** Achieve significantly accelerated output by deploying sub-agents that operate simultaneously on different components of a task.
46+
* **Persistent, Long-Running Orchestration:** Execute workflows for extended durations—hours or even days—to autonomously accomplish complex, long-term development goals.
5047
---
5148

5249
## 🚀 Quick Start
5350

54-
### **Install**
51+
### **Installing and running CodeMachine CLI**
5552

53+
First, install the command-line tool globally:
5654
```bash
5755
npm install -g codemachine # or bun/pnpm/yarn
5856
```
5957

60-
### **Run**
61-
58+
Then, simply run `codemachine` in your project directory to get started:
6259
```bash
6360
codemachine # or cm
6461
```
6562

66-
### **Start**
67-
68-
Hit `/start` and follow the workflow.
69-
70-
That's it.
71-
72-
---
73-
74-
## Why CodeMachine?
75-
76-
* **Build Once, Run Forever:** Define complex workflows once and execute them reliably on every project - stop rebuilding the same patterns manually.
77-
* **Multi-Agent Orchestration:** Assign different coding agents to different tasks - use one for planning, another for implementation, another for review.
78-
* **Parallel Execution:** Run multiple agents simultaneously on different parts of your workflow for faster results.
79-
* **Long-Running Workflows:** Execute workflows for hours or days - CodeMachine handles persistence so you don't have to babysit.
80-
* **Context Engineering:** Centralize prompts, manage dynamic context, and control what each agent sees at each step.
81-
* **Agent Observability:** Trace agent behavior, monitor execution, and refine your workflows with visibility into what's happening.
82-
83-
---
84-
85-
## 🛠️ How It Works
86-
87-
CodeMachine resources live at `~/.codemachine/resources/{version}/` with three core folders:
88-
89-
| Folder | Purpose |
90-
|--------|---------|
91-
| `config/` | Define your agents - who does what |
92-
| `prompts/` | Write instructions - what agents should know |
93-
| `templates/` | Build workflows - how agents work together |
94-
95-
**That's it.** Configure agents, write prompts, connect them in a workflow - then run it whenever you need.
96-
97-
<p align="center">
98-
<a href="./docs/building-workflows.md"><strong>Learn to build workflows →</strong></a>
99-
</p>
100-
101-
---
102-
103-
## 📦 Workflows
104-
105-
CodeMachine ships with ready-to-use workflows. Pick one, customize it, or build your own.
106-
107-
<p align="center">
108-
<table align="center">
109-
<thead>
110-
<tr>
111-
<th align="left">Workflow</th>
112-
<th align="left">Description</th>
113-
</tr>
114-
</thead>
115-
<tbody>
116-
<tr>
117-
<td><strong><a href="https://github.com/bmad-code-org/BMAD-METHOD">🚀 BMAD</a></strong> <em>(Default)</em></td>
118-
<td>Breakthrough Method for Agile AI-Driven Development - full project lifecycle from ideation to deployment</td>
119-
</tr>
120-
<tr>
121-
<td><strong><a href="./docs/workflows/codemachine-one.md">⚡ CodeMachine-One</a></strong></td>
122-
<td>Spec-to-code pipeline - generate code from your specifications</td>
123-
</tr>
124-
</tbody>
125-
</table>
126-
</p>
127-
128-
<p align="center">
129-
<a href="./docs/workflows.md"><strong>Explore all workflows →</strong></a>
130-
</p>
63+
### **Initializing a Project**
13164

132-
---
65+
CodeMachine initializes a `.codemachine/` workspace. To start **add your specs** to the `inputs/specifications.md` file, then **run `/start`** and watch the magic happen, CodeMachine will:
66+
* **Architect a complete system blueprint from your requirements.**
67+
* **Formulate detailed, step-by-step execution plans.**
68+
* **Engineer clean, production-grade code for every component.**
69+
* **Generate essential automation for testing and deployment.**
70+
* **Integrate rigorous validation checks across every phase of execution.**
13371

134-
## ⚙️ Supported AI Engines
72+
### Supported AI Engines
13573

136-
CodeMachine orchestrates CLI-based coding agents. You need at least one installed, and you can use multiple agents in a single workflow.
137-
138-
**Zero config?** If you have OpenCode installed, CodeMachine runs with `glm-4.7-free` by default. For other engines, use `/login` to authenticate.
74+
CodeMachine requires at least one CLI-based AI engine to handle the primary roles of planning and writing code, and is designed to orchestrate multiple engines to collaborate within a single workflow.
13975

14076
<p align="center">
14177
<table align="center">
@@ -152,45 +88,117 @@ CodeMachine orchestrates CLI-based coding agents. You need at least one installe
15288
<tr><td><strong><a href="https://github.com/sst/opencode">OpenCode CLI</a></strong></td><td align="center"><code>✓ Supported</code></td></tr>
15389
<tr><td><strong><a href="https://cursor.com/cli">Cursor CLI</a></strong></td><td align="center"><code>✓ Supported</code></td></tr>
15490
<tr><td><strong><a href="https://www.augmentcode.com/product/CLI">Auggie CLI</a></strong></td><td align="center"><code>✓ Supported</code></td></tr>
155-
<tr><td><strong><a href="https://github.com/mistralai/mistral-vibe">Mistral Vibe</a></strong></td><td align="center"><code>✓ Supported</code></td></tr>
91+
<tr><td><strong><a href="https://github.com/google-gemini/gemini-cli">Gemini CLI</a></strong></td><td align="center"><code>⊙ Coming Soon</code></td></tr>
92+
<tr><td><strong><a href="https://github.com/QwenLM/qwen-code">Qwen Coder</a></strong></td><td align="center"><code>⊙ Coming Soon</code></td></tr>
15693
</tbody>
15794
</table>
15895
</p>
15996

160-
<p align="center">
161-
Can't find your engine listed? <a href="./docs/engines.md"><strong>Check supported engines →</strong></a>
162-
</p>
97+
## **Production Validation:**
16398

164-
---
99+
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.
100+
101+
<table align="center">
102+
<tr>
103+
<td><strong>Services Generated</strong></td>
104+
<td>7 microservices (AI/ML + CRUD APIs)</td>
105+
</tr>
106+
<tr>
107+
<td><strong>Codebase Scale</strong></td>
108+
<td>~500 files, 60K+ Line of code</td>
109+
</tr>
110+
<tr>
111+
<td><strong>Tech Stack</strong></td>
112+
<td>React 18, FastAPI, NestJS, PostgreSQL, MongoDB, Redis, Kubernetes</td>
113+
</tr>
114+
<tr>
115+
<td><strong>Time to MVP</strong></td>
116+
<td>~8 hours of autonomous orchestration</td>
117+
</tr>
118+
</table>
119+
120+
### **CodeMachine vs Regular AI Agents**
121+
122+
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.
123+
124+
<table align="center">
125+
<tr>
126+
<th><strong>Aspect</strong></th>
127+
<th><strong>Regular AI Agents</strong><br/>(Manual Orchestration + Human Review)</th>
128+
<th><strong>CodeMachine</strong><br/>(Autonomous Orchestration)</th>
129+
</tr>
130+
<tr>
131+
<td><strong>Architecture Planning</strong></td>
132+
<td>4-6 hours of manual prompting</td>
133+
<td>Automated (30 min)</td>
134+
</tr>
135+
<tr>
136+
<td><strong>Service Implementation</strong></td>
137+
<td>140-200 hours (7 services × 20-30h each)<br/>Manual prompting, context switching</td>
138+
<td>Parallel execution (5 hours)</td>
139+
</tr>
140+
<tr>
141+
<td><strong>Integration & Testing</strong></td>
142+
<td>30-50 hours<br/>Manual coordination, debugging</td>
143+
<td>Automated validation (2 hours)</td>
144+
</tr>
145+
<tr>
146+
<td><strong>Deployment Setup</strong></td>
147+
<td>8-12 hours<br/>Scripts, configs, orchestration</td>
148+
<td>Auto-generated (30 min)</td>
149+
</tr>
150+
<tr>
151+
<td><strong>Code Consistency</strong></td>
152+
<td>Inconsistent patterns across services<br/>Different coding styles per session</td>
153+
<td>Unified architecture & patterns<br/>Consistent across all components</td>
154+
</tr>
155+
<tr>
156+
<td><strong>Quality Control</strong></td>
157+
<td>Manual review required<br/>Errors compound over time</td>
158+
<td>Built-in validation at each step<br/>Automated sanity checks</td>
159+
</tr>
160+
<tr>
161+
<td><strong>Context Retention</strong></td>
162+
<td>Lost between sessions<br/>Repeated explanations needed</td>
163+
<td>Full project context maintained<br/>Cross-service awareness</td>
164+
</tr>
165+
<tr>
166+
<td><strong>Total Developer Time</strong></td>
167+
<td><strong>~200-300 hours</strong></td>
168+
<td><strong>~8 hours</strong></td>
169+
</tr>
170+
<tr>
171+
<td><strong>Efficiency Gain</strong></td>
172+
<td>Baseline</td>
173+
<td><strong>25-37× faster</strong></td>
174+
</tr>
175+
</table>
165176

166-
## 🌐 Join the Community
177+
<p align="center"><em>Real-world comparison: One developer manually prompting AI coding assistants vs CodeMachine's autonomous multi-agent orchestration</em></p>
178+
179+
---
167180

168181
<p align="center">
169-
Developers are already building with CodeMachine - reducing time and effort on complex, repetitive workflows.<br/>
170-
<strong>Want to see what they're creating? Join us.</strong>
182+
<strong>Want to see how CodeMachine built this?</strong><br/>
183+
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.
171184
</p>
172185

173186
<p align="center">
174-
<a href="https://discord.gg/vS3A5UDNSq">
175-
<img src="https://raw.githubusercontent.com/moazbuilds/CodeMachine-CLI/main/docs/assets/discord-badge.png" alt="Join our Discord" width="200">
176-
</a>
177-
&nbsp;&nbsp;
178-
<a href="https://www.reddit.com/r/CodeMachine/">
179-
<img src="https://raw.githubusercontent.com/moazbuilds/CodeMachine-CLI/main/docs/assets/reddit-badge.png" alt="Join our Reddit" width="200">
180-
</a>
187+
<a href="./docs/case-studies/sustaina.md"><strong>📊 View Complete Case Study & Development Track →</strong></a>
181188
</p>
182189

183190
---
184191

185192
## ⭐ Contributors
186193

187194
<p align="center">
188-
CodeMachine is built with contributions from amazing developers.<br/>
189-
<strong><a href="./CONTRIBUTORS.md">See all contributors →</a></strong>
195+
CodeMachine is built with contributions from amazing developers. Special thanks to everyone who has helped shape this project.
190196
</p>
191197

198+
<p align="center"><strong><a href="./CONTRIBUTORS.md">See all contributors →</a></strong></p>
199+
192200
<p align="center">
193-
Found a bug or have a feature idea? Check our <strong><a href="./CONTRIBUTING.md">Contributing Guide</a></strong>.
201+
Found a bug or have a feature idea? Check our <strong><a href="./CONTRIBUTING.md">Contributing Guide</a></strong> to get started.
194202
</p>
195203

196204
---
@@ -206,12 +214,12 @@ Found a bug or have a feature idea? Check our <strong><a href="./CONTRIBUTING.md
206214
<sub>Complete guides and CLI reference</sub>
207215
</td>
208216
<td align="center">
209-
<strong><a href="./docs/workflows.md">🔄 Workflows</a></strong><br/>
210-
<sub>Explore available workflows</sub>
217+
<strong><a href="./docs/specification-schema.md">📝 Specification Schema</a></strong><br/>
218+
<sub>Learn how to write specifications</sub>
211219
</td>
212220
<td align="center">
213-
<strong><a href="./docs/engines.md">⚙️ Engines</a></strong><br/>
214-
<sub>Supported coding agents</sub>
221+
<strong><a href="./docs/case-studies/sustaina.md">📊 Case Study</a></strong><br/>
222+
<sub>Real-world production example</sub>
215223
</td>
216224
</tr>
217225
</tbody>

0 commit comments

Comments
 (0)