diff options
Diffstat (limited to 'makima/README.md')
| -rw-r--r-- | makima/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/makima/README.md b/makima/README.md index e3e0472..9340da8 100644 --- a/makima/README.md +++ b/makima/README.md @@ -7,3 +7,60 @@ Makima is listening --- Espionage, cybersecurity and surveillance technology + +## Makima CLI + +Makima provides a unified command-line interface for server management, daemon workers, and task orchestration. + +### Quick Start + +```bash +# Build and install +cd makima +cargo install --path . + +# Start the server +makima server --port 8080 --database-url "postgresql://localhost/makima" + +# Connect a daemon worker +export MAKIMA_API_KEY=your-api-key +makima daemon --server-url ws://localhost:8080 +``` + +### Commands + +| Command | Description | +|---------|-------------| +| `makima server` | Run the HTTP/WebSocket server | +| `makima daemon` | Connect to server and manage tasks | +| `makima supervisor` | Contract orchestration (tasks, branches, PRs) | +| `makima contract` | Task-contract interaction (status, files, progress) | + +### Documentation + +See [docs/CLI.md](docs/CLI.md) for comprehensive CLI documentation including: + +- Complete command reference +- Configuration file examples +- Environment variables +- Usage workflows + +### Configuration + +Create `makima-daemon.toml` for daemon configuration: + +```toml +[server] +url = "ws://localhost:8080" +api_key = "your-api-key" + +[process] +max_concurrent_tasks = 4 +``` + +Or use environment variables: + +```bash +export MAKIMA_DAEMON_SERVER_URL=ws://localhost:8080 +export MAKIMA_API_KEY=your-api-key +``` |
