summaryrefslogtreecommitdiff
path: root/makima/README.md
blob: 9340da8aa24052d591bc96c8f68f24d0a6c3be66 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# makima

Makima is listening

[![](https://files.catbox.moe/02cdkj.jpeg)](http://makima.jp)

---

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
```