You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: restructure README with enhanced styling and organization
- Add banner image at top of README as primary visual element
- Reorganize demo assets with versioning (demo.legacy.v1.gif, demo.legacy.v2.gif)
- Simplify supported AI engines table to two-column format with hyperlinks
- Replace emojis with ANSI symbols (✓, ⊙) for cleaner professional look
- Add styled References section with links to docs, spec schema, and case study
- Move detailed contributor info to CONTRIBUTORS.md
- Centralize and streamline Contributors section with contribution call-to-action
- Improve overall visual consistency and navigation throughout README
Special thanks to the following contributors who have helped make CodeMachine better:
4
+
5
+
## Core Contributors
6
+
7
+
### [Bahy Ali](https://github.com/bahyali)
8
+
Architect of the original workflow system and core orchestration concepts. His deep expertise and guidance were instrumental in shaping CodeMachine's foundation.
Added CCR (Claude Code Router) engine support, removing a major limitation by enabling users to leverage AI capabilities beyond subscription-based services.
12
+
13
+
### [SoyHub](https://github.com/SoyHub)
14
+
Enhanced the UI system and contributed innovative ideas during brainstorming sessions that helped strengthen CodeMachine's capabilities.
Added OpenCode CLI engine integration, which brings support for multiple AI providers (Anthropic, OpenAI, Google, and more) to CodeMachine. An enthusiastic and active contributor to the project.
18
+
19
+
---
20
+
21
+
Want to see your name here? Check out our [Contributing Guide](./CONTRIBUTING.md) to get started!
<strong>CodeMachine CLI</strong> is an autonomous multi-agent platform that works locally on your computer, turning specifications into production-ready code.<br></p>
11
+
<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>
9
12
10
13
<palign="center">
11
14
<imgsrc="docs/assets/demo.gif"alt="CodeMachine in Action"width="800">
@@ -24,12 +27,7 @@
24
27
25
28
---
26
29
27
-
## **What is CodeMachine?**
28
-
29
-
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.
30
-
31
-
32
-
**Why CodeMachine?**
30
+
## Why CodeMachine?
33
31
34
32
***Customizable, End-to-End Workflows:** Architect sophisticated orchestration pipelines for any scale, from executing simple scripts to managing multi-day, complex development cycles.
35
33
***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.
@@ -50,38 +48,6 @@ Then, simply run `codemachine` in your project directory to get started.
50
48
```bash
51
49
codemachine
52
50
```
53
-
### **Initializing a Project**
54
-
55
-
### Building from Source
56
-
57
-
CodeMachine ships precompiled binaries for all platforms. For development, testing, or contributing:
58
-
59
-
**Development:**
60
-
```bash
61
-
bun run dev # Run from source (no build needed)
62
-
```
63
-
64
-
**Building Binaries:**
65
-
```bash
66
-
bun run build # Compile binaries for your current platform
67
-
```
68
-
69
-
After building, the CLI shim automatically resolves the local binary when run from this repo.
70
-
To invoke the binary from **any** directory (without publishing), point the shim at the compiled executable:
> Replace `<os>` / `<arch>` with the folder Bun created (for example `codemachine-linux-x64`).
78
-
> On Windows, use `set CODEMACHINE_BIN_PATH=...` and point to `codemachine.exe`.
79
-
80
-
**Publishing:**
81
-
```bash
82
-
bun run build # Run on each target platform
83
-
npm publish # Publish platform packages, then the main package
84
-
```
85
51
86
52
### **Initializing a Project**
87
53
@@ -94,106 +60,29 @@ npm publish # Publish platform packages, then the main package
94
60
95
61
### Supported AI Engines
96
62
97
-
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. The table below shows the current status of supported engines and their platform compatibility.
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.
179
64
180
65
<palign="center">
181
-
<em>✅ Fully Supported | ⚠️ Not Officially Supported | ❌ Not Available</em>
OpenCode ships as a first-class engine. Install the CLI with `npm i -g opencode-ai@latest` (or `brew install opencode`, `scoop install extras/opencode`, `choco install opencode`) and then:
187
-
188
-
-`codemachine opencode run "build hello world"` streams JSON-formatted OpenCode output through CodeMachine’s log markers.
189
-
- Workflow steps can force OpenCode with `codemachine step <agent> --engine opencode --model anthropic/claude-3.7-sonnet`.
190
-
- Guardrail environment defaults (overridable) are applied automatically:
`OPENCODE_DISABLE_LSP_DOWNLOAD=1`, `OPENCODE_DISABLE_DEFAULT_PLUGINS=1`, and `OPENCODE_CONFIG_DIR=$HOME/.codemachine/opencode`.
193
-
- Set `CODEMACHINE_SKIP_OPENCODE=1` for dry-run workflows or `CODEMACHINE_PLAIN_LOGS=1` when you need ANSI-free logs.
194
-
195
-
---
196
-
197
86
## **Production Validation:**
198
87
199
88
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.
@@ -289,79 +178,47 @@ We conducted a real-world comparison by monitoring development work on a project
CodeMachine is built with contributions from amazing developers. Special thanks to everyone who has helped shape this project.
185
+
</p>
356
186
357
-
Special thanks to the following contributors who have helped make CodeMachine better:
187
+
<palign="center"><strong><ahref="./CONTRIBUTORS.md">See all contributors →</a></strong></p>
358
188
359
-
-**[Bahy Ali](https://github.com/bahyali)** - Architect of the original workflow system and core orchestration concepts. His deep expertise and guidance were instrumental in shaping CodeMachine's foundation.
189
+
<palign="center">
190
+
Found a bug or have a feature idea? Check our <strong><ahref="./CONTRIBUTING.md">Contributing Guide</a></strong> to get started.
191
+
</p>
360
192
361
-
-**[Adinda Praditya](https://github.com/apraditya)** - Added CCR (Claude Code Router) engine support, removing a major limitation by enabling users to leverage AI capabilities beyond subscription-based services.
193
+
---
362
194
363
-
-**[SoyHub](https://github.com/SoyHub)** - Enhanced the UI system and contributed innovative ideas during brainstorming sessions that helped strengthen CodeMachine's capabilities.
195
+
## 📖 References
364
196
365
-
-**[TheMightyDman](https://github.com/TheMightyDman)** - Added OpenCode CLI engine integration, which brings support for multiple AI providers (Anthropic, OpenAI, Google, and more) to CodeMachine. An enthusiastic and active contributor to the project.
0 commit comments