Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.codemachine.co/llms.txt

Use this file to discover all available pages before exploring further.

​
System Requirements

​
For Users (Binary Installation)

The CodeMachine binary bundles the Bun runtime, so no additional tooling is required.
RequirementDetails
OSLinux (x64, arm64), macOS (x64, arm64), Windows (x64)
RAM4GB minimum, 8GB+ recommended for parallel agents
Disk100MB for binary + space for logs
AI EngineAt least one supported engine installed (Claude Code, Codex, etc.)

​
For Developers (Building from Source)

RequirementVersion
Bun>= 1.3.3
Node.js>= 20.10.0 (for tooling)
GitLatest

​
Resource Scaling Guide

Running multiple parallel agents requires additional system resources. Use this table to plan your infrastructure:
WorkloadRAMCPUNotes
Single agent2 GB1 coreLight tasks
5 parallel agents4 GB2 coresSmall workflows
10-20 parallel agents8-16 GB4+ coresProduction workflows
20+ parallel agents32 GB+8+ coresHeavy swarms
These requirements are for running multiple AI engine processes simultaneously, not for build tooling.

​
Building from Source

1

Clone the Repository

git clone https://github.com/moazbuilds/CodeMachine-CLI.git
cd CodeMachine-CLI
2

Install Dependencies

bun install
3

Run in Development Mode

bun dev
4

Build for Production

bun run build

Optional: Link bun globally

​
Manual Installation

If you prefer not to use a package manager, you can download the binary directly from the GitHub Releases page. 
# Download the binary for your platform
curl -fsSL https://github.com/moazbuilds/CodeMachine-CLI/releases/latest/download/codemachine-linux-x64 -o codemachine

# Make it executable
chmod +x codemachine

# Move to your PATH
sudo mv codemachine /usr/local/bin/

# Create cm alias
sudo ln -s /usr/local/bin/codemachine /usr/local/bin/cm

​
Manual Update

npm i -g codemachine@latest

​
Uninstallation

npm uninstall -g codemachine
Configuration files are stored in ~/.codemachine/. Remove this directory to completely clean up. Also remove ./.codemachine in your project to delete runtime data and reset CodeMachine.