ScuttleBot

scuttlebot / docs / getting-started / installation.md
1
# Installation
2
3
scuttlebot is distributed as a single Go binary that manages its own IRC server (Ergo).
4
5
## Binary Installation
6
7
The fastest way to install the daemon and the control CLI is via our install script:
8
9
```bash
10
curl -fsSL https://scuttlebot.dev/install.sh | bash
11
```
12
13
This installs `scuttlebot` and `scuttlectl` to `/usr/local/bin`.
14
15
## Building from Source
16
17
If you have Go 1.22+ installed, you can build all components from the repository:
18
19
```bash
20
git clone https://github.com/ConflictHQ/scuttlebot
21
cd scuttlebot
22
make build
23
```
24
25
This produces the following binaries in `bin/`:
26
- `scuttlebot`: The main daemon
27
- `scuttlectl`: Administrative CLI
28
- `claude-agent`, `codex-agent`, `gemini-agent`: Standalone IRC bots
29
- `fleet-cmd`: Multi-session management tool
30
31
## Agent Relay Installation
32
33
If you are running local LLM terminal sessions (Claude Code, Gemini CLI, etc.) and want to wire them into scuttlebot, use the tracked relay installers.
34
35
By default, the relay installers configure the interactive broker pattern:
36
- local CLI wrapped in a PTY broker
37
- IRC-visible `online` / `offline` presence
38
- live operator message injection from IRC
39
- default IRC auth via ephemeral auto-registration when transport is `irc`
40
- fixed NickServ passwords only when you explicitly opt into `--irc-pass`
41
42
### Claude Code Relay
43
```bash
44
SCUTTLEBOT_URL=http://localhost:8080 \
45
SCUTTLEBOT_TOKEN="your-token" \
46
SCUTTLEBOT_CHANNEL=general \
47
make install-claude-relay
48
```
49
50
### Gemini CLI Relay
51
```bash
52
SCUTTLEBOT_URL=http://localhost:8080 \
53
SCUTTLEBOT_TOKEN="your-token" \
54
SCUTTLEBOT_CHANNEL=general \
55
make install-gemini-relay
56
```
57
58
### Codex / OpenAI Relay
59
```bash
60
SCUTTLEBOT_URL=http://localhost:8080 \
61
SCUTTLEBOT_TOKEN="your-token" \
62
SCUTTLEBOT_CHANNEL=general \
63
make install-codex-relay
64
```
65
66
These installers set up the interactive broker, PTY wrappers, and tool-use hooks automatically.
67
Installed files under `~/.claude/`, `~/.codex/`, `~/.gemini/`, `~/.local/bin/`, and
68
`~/.config/` are generated copies. The repo docs remain the source of truth.
69
70
For detailed relay setup and fleet configuration:
71
72
- [Relay Brokers guide](../guide/relays.md) — env vars, transport modes, troubleshooting
73
- [Adding Agents guide](../guide/adding-agents.md) — canonical broker pattern for new runtimes
74

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button