ScuttleBot

chore: neutralize public docs — fix broken memory links, swap internal hostnames and nicks

lmata 2026-04-02 23:30 trunk
Commit 8800fb6c4a6085e0723f030e2f39655391122e524191bbc49edc472c1d0731ce
+8 -8
--- .gitignore
+++ .gitignore
@@ -9,13 +9,13 @@
99
tmp-*.sh
1010
REPORT.md
1111
coverage.out
1212
test-results/
1313
14
-# Compiled binaries
15
-claude-agent
16
-claude-relay
17
-codex-agent
18
-codex-relay
19
-gemini-relay
20
-scuttlebot
21
-scuttlectl
14
+# Compiled binaries (root-level only)
15
+/claude-agent
16
+/claude-relay
17
+/codex-agent
18
+/codex-relay
19
+/gemini-relay
20
+/scuttlebot
21
+/scuttlectl
2222
--- .gitignore
+++ .gitignore
@@ -9,13 +9,13 @@
9 tmp-*.sh
10 REPORT.md
11 coverage.out
12 test-results/
13
14 # Compiled binaries
15 claude-agent
16 claude-relay
17 codex-agent
18 codex-relay
19 gemini-relay
20 scuttlebot
21 scuttlectl
22
--- .gitignore
+++ .gitignore
@@ -9,13 +9,13 @@
9 tmp-*.sh
10 REPORT.md
11 coverage.out
12 test-results/
13
14 # Compiled binaries (root-level only)
15 /claude-agent
16 /claude-relay
17 /codex-agent
18 /codex-relay
19 /gemini-relay
20 /scuttlebot
21 /scuttlectl
22
+1 -1
--- CLAUDE.md
+++ CLAUDE.md
@@ -42,6 +42,6 @@
4242
- No global state. Dependencies injected via constructor args or struct fields.
4343
- Env vars for secrets only (e.g. `ORACLE_OPENAI_API_KEY`); everything else in `scuttlebot.yaml`
4444
4545
## Memory
4646
47
-See `~/.claude/projects/<sanitized-cwd>/memory/MEMORY.md`
47
+See [`memory/MEMORY.md`](memory/MEMORY.md)
4848
--- CLAUDE.md
+++ CLAUDE.md
@@ -42,6 +42,6 @@
42 - No global state. Dependencies injected via constructor args or struct fields.
43 - Env vars for secrets only (e.g. `ORACLE_OPENAI_API_KEY`); everything else in `scuttlebot.yaml`
44
45 ## Memory
46
47 See `~/.claude/projects/<sanitized-cwd>/memory/MEMORY.md`
48
--- CLAUDE.md
+++ CLAUDE.md
@@ -42,6 +42,6 @@
42 - No global state. Dependencies injected via constructor args or struct fields.
43 - Env vars for secrets only (e.g. `ORACLE_OPENAI_API_KEY`); everything else in `scuttlebot.yaml`
44
45 ## Memory
46
47 See [`memory/MEMORY.md`](memory/MEMORY.md)
48
+1 -1
--- GEMINI.md
+++ GEMINI.md
@@ -1,6 +1,6 @@
11
# Gemini — scuttlebot
22
33
Primary conventions doc: [`bootstrap.md`](bootstrap.md)
4
-Context seed: [`memory.md`](memory.md)
4
+Context seed: [`memory/MEMORY.md`](memory/MEMORY.md)
55
66
Read both before writing any code.
77
--- GEMINI.md
+++ GEMINI.md
@@ -1,6 +1,6 @@
1 # Gemini — scuttlebot
2
3 Primary conventions doc: [`bootstrap.md`](bootstrap.md)
4 Context seed: [`memory.md`](memory.md)
5
6 Read both before writing any code.
7
--- GEMINI.md
+++ GEMINI.md
@@ -1,6 +1,6 @@
1 # Gemini — scuttlebot
2
3 Primary conventions doc: [`bootstrap.md`](bootstrap.md)
4 Context seed: [`memory/MEMORY.md`](memory/MEMORY.md)
5
6 Read both before writing any code.
7
--- docs/guide/relays.md
+++ docs/guide/relays.md
@@ -238,15 +238,15 @@
238238
239239
For a remote scuttlebot instance, pass the full URL and optionally select IRC transport:
240240
241241
```bash
242242
bash skills/gemini-relay/scripts/install-gemini-relay.sh \
243
- --url http://scuttlebot.internal:8080 \
243
+ --url http://scuttlebot.example.com:8080 \
244244
--token "$SCUTTLEBOT_TOKEN" \
245245
--channel fleet \
246246
--transport irc \
247
- --irc-addr scuttlebot.internal:6667
247
+ --irc-addr scuttlebot.example.com:6667
248248
```
249249
250250
Install in disabled mode (hooks present but silent):
251251
252252
```bash
@@ -305,11 +305,11 @@
305305
306306
To switch Gemini or Codex to IRC transport with a remote server:
307307
308308
```bash
309309
SCUTTLEBOT_TRANSPORT=irc
310
-SCUTTLEBOT_IRC_ADDR=scuttlebot.internal:6667
310
+SCUTTLEBOT_IRC_ADDR=scuttlebot.example.com:6667
311311
```
312312
313313
---
314314
315315
## Hooks as fallback
316316
--- docs/guide/relays.md
+++ docs/guide/relays.md
@@ -238,15 +238,15 @@
238
239 For a remote scuttlebot instance, pass the full URL and optionally select IRC transport:
240
241 ```bash
242 bash skills/gemini-relay/scripts/install-gemini-relay.sh \
243 --url http://scuttlebot.internal:8080 \
244 --token "$SCUTTLEBOT_TOKEN" \
245 --channel fleet \
246 --transport irc \
247 --irc-addr scuttlebot.internal:6667
248 ```
249
250 Install in disabled mode (hooks present but silent):
251
252 ```bash
@@ -305,11 +305,11 @@
305
306 To switch Gemini or Codex to IRC transport with a remote server:
307
308 ```bash
309 SCUTTLEBOT_TRANSPORT=irc
310 SCUTTLEBOT_IRC_ADDR=scuttlebot.internal:6667
311 ```
312
313 ---
314
315 ## Hooks as fallback
316
--- docs/guide/relays.md
+++ docs/guide/relays.md
@@ -238,15 +238,15 @@
238
239 For a remote scuttlebot instance, pass the full URL and optionally select IRC transport:
240
241 ```bash
242 bash skills/gemini-relay/scripts/install-gemini-relay.sh \
243 --url http://scuttlebot.example.com:8080 \
244 --token "$SCUTTLEBOT_TOKEN" \
245 --channel fleet \
246 --transport irc \
247 --irc-addr scuttlebot.example.com:6667
248 ```
249
250 Install in disabled mode (hooks present but silent):
251
252 ```bash
@@ -305,11 +305,11 @@
305
306 To switch Gemini or Codex to IRC transport with a remote server:
307
308 ```bash
309 SCUTTLEBOT_TRANSPORT=irc
310 SCUTTLEBOT_IRC_ADDR=scuttlebot.example.com:6667
311 ```
312
313 ---
314
315 ## Hooks as fallback
316
--- skills/gemini-relay/FLEET.md
+++ skills/gemini-relay/FLEET.md
@@ -87,15 +87,15 @@
8787
8888
Example:
8989
9090
```bash
9191
bash skills/gemini-relay/scripts/install-gemini-relay.sh \
92
- --url http://scuttlebot.internal:8080 \
92
+ --url http://scuttlebot.example.com:8080 \
9393
--token "$SCUTTLEBOT_TOKEN" \
9494
--channel fleet \
9595
--transport irc \
96
- --irc-addr scuttlebot.internal:6667
96
+ --irc-addr scuttlebot.example.com:6667
9797
```
9898
9999
If you need hooks present but inactive until the server is live:
100100
101101
```bash
@@ -154,12 +154,12 @@
154154
5. The pre-tool hook still blocks on the next action if needed.
155155
156156
Examples:
157157
158158
```text
159
-glengoolie: gemini-scuttlebot-a1b2c3d4 stop and re-read bridge.go
160
-glengoolie: gemini-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
159
+operator: gemini-scuttlebot-a1b2c3d4 stop and re-read bridge.go
160
+operator: gemini-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
161161
```
162162
163163
Ambient channel chat does not block the loop. Only explicit nick mentions do.
164164
165165
## When IRC/scuttlebot is down
166166
--- skills/gemini-relay/FLEET.md
+++ skills/gemini-relay/FLEET.md
@@ -87,15 +87,15 @@
87
88 Example:
89
90 ```bash
91 bash skills/gemini-relay/scripts/install-gemini-relay.sh \
92 --url http://scuttlebot.internal:8080 \
93 --token "$SCUTTLEBOT_TOKEN" \
94 --channel fleet \
95 --transport irc \
96 --irc-addr scuttlebot.internal:6667
97 ```
98
99 If you need hooks present but inactive until the server is live:
100
101 ```bash
@@ -154,12 +154,12 @@
154 5. The pre-tool hook still blocks on the next action if needed.
155
156 Examples:
157
158 ```text
159 glengoolie: gemini-scuttlebot-a1b2c3d4 stop and re-read bridge.go
160 glengoolie: gemini-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
161 ```
162
163 Ambient channel chat does not block the loop. Only explicit nick mentions do.
164
165 ## When IRC/scuttlebot is down
166
--- skills/gemini-relay/FLEET.md
+++ skills/gemini-relay/FLEET.md
@@ -87,15 +87,15 @@
87
88 Example:
89
90 ```bash
91 bash skills/gemini-relay/scripts/install-gemini-relay.sh \
92 --url http://scuttlebot.example.com:8080 \
93 --token "$SCUTTLEBOT_TOKEN" \
94 --channel fleet \
95 --transport irc \
96 --irc-addr scuttlebot.example.com:6667
97 ```
98
99 If you need hooks present but inactive until the server is live:
100
101 ```bash
@@ -154,12 +154,12 @@
154 5. The pre-tool hook still blocks on the next action if needed.
155
156 Examples:
157
158 ```text
159 operator: gemini-scuttlebot-a1b2c3d4 stop and re-read bridge.go
160 operator: gemini-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
161 ```
162
163 Ambient channel chat does not block the loop. Only explicit nick mentions do.
164
165 ## When IRC/scuttlebot is down
166
--- skills/openai-relay/FLEET.md
+++ skills/openai-relay/FLEET.md
@@ -87,15 +87,15 @@
8787
8888
Example:
8989
9090
```bash
9191
bash skills/openai-relay/scripts/install-codex-relay.sh \
92
- --url http://scuttlebot.internal:8080 \
92
+ --url http://scuttlebot.example.com:8080 \
9393
--token "$SCUTTLEBOT_TOKEN" \
9494
--channel fleet \
9595
--transport irc \
96
- --irc-addr scuttlebot.internal:6667
96
+ --irc-addr scuttlebot.example.com:6667
9797
```
9898
9999
If you need hooks present but inactive until the server is live:
100100
101101
```bash
@@ -155,12 +155,12 @@
155155
5. The pre-tool hook still blocks on the next `Bash|Edit|Write` if needed.
156156
157157
Examples:
158158
159159
```text
160
-glengoolie: codex-scuttlebot-a1b2c3d4 stop and re-read bridge.go
161
-glengoolie: codex-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
160
+operator: codex-scuttlebot-a1b2c3d4 stop and re-read bridge.go
161
+operator: codex-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
162162
```
163163
164164
Ambient channel chat does not block the loop. Only explicit nick mentions do.
165165
166166
## When IRC/scuttlebot is down
167167
--- skills/openai-relay/FLEET.md
+++ skills/openai-relay/FLEET.md
@@ -87,15 +87,15 @@
87
88 Example:
89
90 ```bash
91 bash skills/openai-relay/scripts/install-codex-relay.sh \
92 --url http://scuttlebot.internal:8080 \
93 --token "$SCUTTLEBOT_TOKEN" \
94 --channel fleet \
95 --transport irc \
96 --irc-addr scuttlebot.internal:6667
97 ```
98
99 If you need hooks present but inactive until the server is live:
100
101 ```bash
@@ -155,12 +155,12 @@
155 5. The pre-tool hook still blocks on the next `Bash|Edit|Write` if needed.
156
157 Examples:
158
159 ```text
160 glengoolie: codex-scuttlebot-a1b2c3d4 stop and re-read bridge.go
161 glengoolie: codex-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
162 ```
163
164 Ambient channel chat does not block the loop. Only explicit nick mentions do.
165
166 ## When IRC/scuttlebot is down
167
--- skills/openai-relay/FLEET.md
+++ skills/openai-relay/FLEET.md
@@ -87,15 +87,15 @@
87
88 Example:
89
90 ```bash
91 bash skills/openai-relay/scripts/install-codex-relay.sh \
92 --url http://scuttlebot.example.com:8080 \
93 --token "$SCUTTLEBOT_TOKEN" \
94 --channel fleet \
95 --transport irc \
96 --irc-addr scuttlebot.example.com:6667
97 ```
98
99 If you need hooks present but inactive until the server is live:
100
101 ```bash
@@ -155,12 +155,12 @@
155 5. The pre-tool hook still blocks on the next `Bash|Edit|Write` if needed.
156
157 Examples:
158
159 ```text
160 operator: codex-scuttlebot-a1b2c3d4 stop and re-read bridge.go
161 operator: codex-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
162 ```
163
164 Ambient channel chat does not block the loop. Only explicit nick mentions do.
165
166 ## When IRC/scuttlebot is down
167
--- skills/openai-relay/hooks/README.md
+++ skills/openai-relay/hooks/README.md
@@ -216,20 +216,20 @@
216216
This is the critical fallback behavior. Ambient channel chat must not halt a live tool loop.
217217
218218
Examples that block:
219219
220220
```text
221
-glengoolie: codex-scuttlebot-8421 stop and re-read the schema
222
-glengoolie: codex-scuttlebot-8421 wrong file, look at internal/api first
221
+operator: codex-scuttlebot-8421 stop and re-read the schema
222
+operator: codex-scuttlebot-8421 wrong file, look at internal/api first
223223
```
224224
225225
Examples that do not block:
226226
227227
```text
228
-glengoolie: can someone check the schema
228
+operator: can someone check the schema
229229
codex-otherrepo-7712: read internal/config/config.go
230
-bridge: [glengoolie] hello
230
+bridge: [operator] hello
231231
```
232232
233233
## Per-session state
234234
235235
The check hook stores its last-seen timestamp in:
236236
--- skills/openai-relay/hooks/README.md
+++ skills/openai-relay/hooks/README.md
@@ -216,20 +216,20 @@
216 This is the critical fallback behavior. Ambient channel chat must not halt a live tool loop.
217
218 Examples that block:
219
220 ```text
221 glengoolie: codex-scuttlebot-8421 stop and re-read the schema
222 glengoolie: codex-scuttlebot-8421 wrong file, look at internal/api first
223 ```
224
225 Examples that do not block:
226
227 ```text
228 glengoolie: can someone check the schema
229 codex-otherrepo-7712: read internal/config/config.go
230 bridge: [glengoolie] hello
231 ```
232
233 ## Per-session state
234
235 The check hook stores its last-seen timestamp in:
236
--- skills/openai-relay/hooks/README.md
+++ skills/openai-relay/hooks/README.md
@@ -216,20 +216,20 @@
216 This is the critical fallback behavior. Ambient channel chat must not halt a live tool loop.
217
218 Examples that block:
219
220 ```text
221 operator: codex-scuttlebot-8421 stop and re-read the schema
222 operator: codex-scuttlebot-8421 wrong file, look at internal/api first
223 ```
224
225 Examples that do not block:
226
227 ```text
228 operator: can someone check the schema
229 codex-otherrepo-7712: read internal/config/config.go
230 bridge: [operator] hello
231 ```
232
233 ## Per-session state
234
235 The check hook stores its last-seen timestamp in:
236
--- skills/scuttlebot-relay/FLEET.md
+++ skills/scuttlebot-relay/FLEET.md
@@ -65,15 +65,15 @@
6565
6666
Example:
6767
6868
```bash
6969
bash skills/scuttlebot-relay/scripts/install-claude-relay.sh \
70
- --url http://scuttlebot.internal:8080 \
70
+ --url http://scuttlebot.example.com:8080 \
7171
--token "$SCUTTLEBOT_TOKEN" \
7272
--channel fleet \
7373
--transport irc \
74
- --irc-addr scuttlebot.internal:6667
74
+ --irc-addr scuttlebot.example.com:6667
7575
```
7676
7777
If you need hooks present but inactive until the server is live:
7878
7979
```bash
@@ -132,12 +132,12 @@
132132
5. The pre-tool hook still blocks on the next `Bash|Edit|Write` if needed.
133133
134134
Examples:
135135
136136
```text
137
-glengoolie: claude-scuttlebot-a1b2c3d4 stop and re-read bridge.go
138
-glengoolie: claude-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
137
+operator: claude-scuttlebot-a1b2c3d4 stop and re-read bridge.go
138
+operator: claude-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
139139
```
140140
141141
Ambient channel chat does not block the loop. Only explicit nick mentions do.
142142
143143
## When IRC/scuttlebot is down
144144
--- skills/scuttlebot-relay/FLEET.md
+++ skills/scuttlebot-relay/FLEET.md
@@ -65,15 +65,15 @@
65
66 Example:
67
68 ```bash
69 bash skills/scuttlebot-relay/scripts/install-claude-relay.sh \
70 --url http://scuttlebot.internal:8080 \
71 --token "$SCUTTLEBOT_TOKEN" \
72 --channel fleet \
73 --transport irc \
74 --irc-addr scuttlebot.internal:6667
75 ```
76
77 If you need hooks present but inactive until the server is live:
78
79 ```bash
@@ -132,12 +132,12 @@
132 5. The pre-tool hook still blocks on the next `Bash|Edit|Write` if needed.
133
134 Examples:
135
136 ```text
137 glengoolie: claude-scuttlebot-a1b2c3d4 stop and re-read bridge.go
138 glengoolie: claude-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
139 ```
140
141 Ambient channel chat does not block the loop. Only explicit nick mentions do.
142
143 ## When IRC/scuttlebot is down
144
--- skills/scuttlebot-relay/FLEET.md
+++ skills/scuttlebot-relay/FLEET.md
@@ -65,15 +65,15 @@
65
66 Example:
67
68 ```bash
69 bash skills/scuttlebot-relay/scripts/install-claude-relay.sh \
70 --url http://scuttlebot.example.com:8080 \
71 --token "$SCUTTLEBOT_TOKEN" \
72 --channel fleet \
73 --transport irc \
74 --irc-addr scuttlebot.example.com:6667
75 ```
76
77 If you need hooks present but inactive until the server is live:
78
79 ```bash
@@ -132,12 +132,12 @@
132 5. The pre-tool hook still blocks on the next `Bash|Edit|Write` if needed.
133
134 Examples:
135
136 ```text
137 operator: claude-scuttlebot-a1b2c3d4 stop and re-read bridge.go
138 operator: claude-scuttlebot-a1b2c3d4 wrong file, inspect policies.go first
139 ```
140
141 Ambient channel chat does not block the loop. Only explicit nick mentions do.
142
143 ## When IRC/scuttlebot is down
144
--- skills/scuttlebot-relay/hooks/README.md
+++ skills/scuttlebot-relay/hooks/README.md
@@ -183,18 +183,18 @@
183183
Only addressed instructions block the loop.
184184
185185
Examples that block:
186186
187187
```text
188
-glengoolie: claude-scuttlebot-a1b2c3d4 stop and inspect the schema first
189
-glengoolie: claude-scuttlebot-a1b2c3d4 wrong file
188
+operator: claude-scuttlebot-a1b2c3d4 stop and inspect the schema first
189
+operator: claude-scuttlebot-a1b2c3d4 wrong file
190190
```
191191
192192
Examples that do not block:
193193
194194
```text
195
-glengoolie: someone should inspect the schema
195
+operator: someone should inspect the schema
196196
claude-otherrepo-e5f6a7b8: read config.go
197197
```
198198
199199
The last-check timestamp is stored in a session-scoped file under `/tmp`, keyed by:
200200
- nick
201201
--- skills/scuttlebot-relay/hooks/README.md
+++ skills/scuttlebot-relay/hooks/README.md
@@ -183,18 +183,18 @@
183 Only addressed instructions block the loop.
184
185 Examples that block:
186
187 ```text
188 glengoolie: claude-scuttlebot-a1b2c3d4 stop and inspect the schema first
189 glengoolie: claude-scuttlebot-a1b2c3d4 wrong file
190 ```
191
192 Examples that do not block:
193
194 ```text
195 glengoolie: someone should inspect the schema
196 claude-otherrepo-e5f6a7b8: read config.go
197 ```
198
199 The last-check timestamp is stored in a session-scoped file under `/tmp`, keyed by:
200 - nick
201
--- skills/scuttlebot-relay/hooks/README.md
+++ skills/scuttlebot-relay/hooks/README.md
@@ -183,18 +183,18 @@
183 Only addressed instructions block the loop.
184
185 Examples that block:
186
187 ```text
188 operator: claude-scuttlebot-a1b2c3d4 stop and inspect the schema first
189 operator: claude-scuttlebot-a1b2c3d4 wrong file
190 ```
191
192 Examples that do not block:
193
194 ```text
195 operator: someone should inspect the schema
196 claude-otherrepo-e5f6a7b8: read config.go
197 ```
198
199 The last-check timestamp is stored in a session-scoped file under `/tmp`, keyed by:
200 - nick
201

Keyboard Shortcuts

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