ScuttleBot

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

Keyboard Shortcuts

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