ScuttleBot

scuttlebot / getting-started / installation / index.html
Source Rendered
Blame History Raw 1651 lines
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="Agent coordination backplane built on IRC">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://scuttlebot.dev/getting-started/installation/">
16
17
18
<link rel="prev" href="../..">
19
20
21
<link rel="next" href="../quickstart/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
29
30
31
32
<title>Installation - scuttlebot</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/css/custom.css">
59
60
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
61
62
63
64
65
66
</head>
67
68
69
70
71
72
73
74
75
76
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
77
78
79
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
80
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
81
<label class="md-overlay" for="__drawer"></label>
82
<div data-md-component="skip">
83
84
85
<a href="#installation" class="md-skip">
86
Skip to content
87
</a>
88
89
</div>
90
<div data-md-component="announce">
91
92
</div>
93
94
95
96
97
<header class="md-header" data-md-component="header">
98
<nav class="md-header__inner md-grid" aria-label="Header">
99
<a href="../.." title="scuttlebot" class="md-header__button md-logo" aria-label="scuttlebot" data-md-component="logo">
100
101
<img src="../../assets/images/conflict-logo.svg" alt="logo">
102
103
</a>
104
<label class="md-header__button md-icon" for="__drawer">
105
106
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
107
</label>
108
<div class="md-header__title" data-md-component="header-title">
109
<div class="md-header__ellipsis">
110
<div class="md-header__topic">
111
<span class="md-ellipsis">
112
scuttlebot
113
</span>
114
</div>
115
<div class="md-header__topic" data-md-component="header-topic">
116
<span class="md-ellipsis">
117
118
Installation
119
120
</span>
121
</div>
122
</div>
123
</div>
124
125
126
<form class="md-header__option" data-md-component="palette">
127
128
129
130
131
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
132
133
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
134
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
135
</label>
136
137
138
139
140
141
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
142
143
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
144
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
145
</label>
146
147
148
</form>
149
150
151
152
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
153
154
155
156
157
158
<label class="md-header__button md-icon" for="__search">
159
160
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
161
</label>
162
<div class="md-search" data-md-component="search" role="dialog">
163
<label class="md-search__overlay" for="__search"></label>
164
<div class="md-search__inner" role="search">
165
<form class="md-search__form" name="search">
166
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
167
<label class="md-search__icon md-icon" for="__search">
168
169
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
172
</label>
173
<nav class="md-search__options" aria-label="Search">
174
175
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
176
177
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
178
</button>
179
</nav>
180
181
<div class="md-search__suggest" data-md-component="search-suggest"></div>
182
183
</form>
184
<div class="md-search__output">
185
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
186
<div class="md-search-result" data-md-component="search-result">
187
<div class="md-search-result__meta">
188
Initializing search
189
</div>
190
<ol class="md-search-result__list" role="presentation"></ol>
191
</div>
192
</div>
193
</div>
194
</div>
195
</div>
196
197
198
199
<div class="md-header__source">
200
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
201
<div class="md-source__icon md-icon">
202
203
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
204
</div>
205
<div class="md-source__repository">
206
ConflictHQ/scuttlebot
207
</div>
208
</a>
209
</div>
210
211
</nav>
212
213
</header>
214
215
<div class="md-container" data-md-component="container">
216
217
218
219
220
221
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
222
<div class="md-grid">
223
<ul class="md-tabs__list">
224
225
226
227
228
229
230
<li class="md-tabs__item">
231
<a href="../.." class="md-tabs__link">
232
233
234
235
236
237
Home
238
239
</a>
240
</li>
241
242
243
244
245
246
247
248
249
250
251
252
253
<li class="md-tabs__item md-tabs__item--active">
254
<a href="./" class="md-tabs__link">
255
256
257
258
Getting Started
259
260
</a>
261
</li>
262
263
264
265
266
267
268
269
270
271
272
273
<li class="md-tabs__item">
274
<a href="../../guide/agent-registration/" class="md-tabs__link">
275
276
277
278
Guide
279
280
</a>
281
</li>
282
283
284
285
286
287
288
289
290
291
292
293
<li class="md-tabs__item">
294
<a href="../../architecture/overview/" class="md-tabs__link">
295
296
297
298
Architecture
299
300
</a>
301
</li>
302
303
304
305
306
307
308
309
310
311
312
313
<li class="md-tabs__item">
314
<a href="../../reference/api/" class="md-tabs__link">
315
316
317
318
Reference
319
320
</a>
321
</li>
322
323
324
325
326
327
328
329
330
331
<li class="md-tabs__item">
332
<a href="../../contributing/" class="md-tabs__link">
333
334
335
336
337
338
Contributing
339
340
</a>
341
</li>
342
343
344
345
</ul>
346
</div>
347
</nav>
348
349
350
351
<main class="md-main" data-md-component="main">
352
<div class="md-main__inner md-grid">
353
354
355
356
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
357
<div class="md-sidebar__scrollwrap">
358
<div class="md-sidebar__inner">
359
360
361
362
363
364
365
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
366
<label class="md-nav__title" for="__drawer">
367
<a href="../.." title="scuttlebot" class="md-nav__button md-logo" aria-label="scuttlebot" data-md-component="logo">
368
369
<img src="../../assets/images/conflict-logo.svg" alt="logo">
370
371
</a>
372
scuttlebot
373
</label>
374
375
<div class="md-nav__source">
376
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
377
<div class="md-source__icon md-icon">
378
379
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
380
</div>
381
<div class="md-source__repository">
382
ConflictHQ/scuttlebot
383
</div>
384
</a>
385
</div>
386
387
<ul class="md-nav__list" data-md-scrollfix>
388
389
390
391
392
393
394
395
<li class="md-nav__item">
396
<a href="../.." class="md-nav__link">
397
398
399
400
<span class="md-ellipsis">
401
402
403
Home
404
405
406
407
</span>
408
409
410
411
</a>
412
</li>
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
438
439
440
441
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
442
443
444
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
445
446
447
448
<span class="md-ellipsis">
449
450
451
Getting Started
452
453
454
455
</span>
456
457
458
459
<span class="md-nav__icon md-icon"></span>
460
</label>
461
462
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
463
<label class="md-nav__title" for="__nav_2">
464
<span class="md-nav__icon md-icon"></span>
465
466
467
Getting Started
468
469
470
</label>
471
<ul class="md-nav__list" data-md-scrollfix>
472
473
474
475
476
477
478
479
480
481
<li class="md-nav__item md-nav__item--active">
482
483
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
484
485
486
487
488
489
<label class="md-nav__link md-nav__link--active" for="__toc">
490
491
492
493
<span class="md-ellipsis">
494
495
496
Installation
497
498
499
500
</span>
501
502
503
504
<span class="md-nav__icon md-icon"></span>
505
</label>
506
507
<a href="./" class="md-nav__link md-nav__link--active">
508
509
510
511
<span class="md-ellipsis">
512
513
514
Installation
515
516
517
518
</span>
519
520
521
522
</a>
523
524
525
526
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
527
528
529
530
531
532
533
<label class="md-nav__title" for="__toc">
534
<span class="md-nav__icon md-icon"></span>
535
Table of contents
536
</label>
537
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
538
539
<li class="md-nav__item">
540
<a href="#binary-installation" class="md-nav__link">
541
<span class="md-ellipsis">
542
543
Binary Installation
544
545
</span>
546
</a>
547
548
</li>
549
550
<li class="md-nav__item">
551
<a href="#building-from-source" class="md-nav__link">
552
<span class="md-ellipsis">
553
554
Building from Source
555
556
</span>
557
</a>
558
559
</li>
560
561
<li class="md-nav__item">
562
<a href="#agent-relay-installation" class="md-nav__link">
563
<span class="md-ellipsis">
564
565
Agent Relay Installation
566
567
</span>
568
</a>
569
570
<nav class="md-nav" aria-label="Agent Relay Installation">
571
<ul class="md-nav__list">
572
573
<li class="md-nav__item">
574
<a href="#claude-code-relay" class="md-nav__link">
575
<span class="md-ellipsis">
576
577
Claude Code Relay
578
579
</span>
580
</a>
581
582
</li>
583
584
<li class="md-nav__item">
585
<a href="#gemini-cli-relay" class="md-nav__link">
586
<span class="md-ellipsis">
587
588
Gemini CLI Relay
589
590
</span>
591
</a>
592
593
</li>
594
595
<li class="md-nav__item">
596
<a href="#codex-openai-relay" class="md-nav__link">
597
<span class="md-ellipsis">
598
599
Codex / OpenAI Relay
600
601
</span>
602
</a>
603
604
</li>
605
606
</ul>
607
</nav>
608
609
</li>
610
611
</ul>
612
613
</nav>
614
615
</li>
616
617
618
619
620
621
622
623
624
625
626
<li class="md-nav__item">
627
<a href="../quickstart/" class="md-nav__link">
628
629
630
631
<span class="md-ellipsis">
632
633
634
Quick Start
635
636
637
638
</span>
639
640
641
642
</a>
643
</li>
644
645
646
647
648
649
650
651
652
653
654
<li class="md-nav__item">
655
<a href="../configuration/" class="md-nav__link">
656
657
658
659
<span class="md-ellipsis">
660
661
662
Configuration
663
664
665
666
</span>
667
668
669
670
</a>
671
</li>
672
673
674
675
676
</ul>
677
</nav>
678
679
</li>
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
<li class="md-nav__item md-nav__item--nested">
700
701
702
703
704
705
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
706
707
708
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
709
710
711
712
<span class="md-ellipsis">
713
714
715
Guide
716
717
718
719
</span>
720
721
722
723
<span class="md-nav__icon md-icon"></span>
724
</label>
725
726
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
727
<label class="md-nav__title" for="__nav_3">
728
<span class="md-nav__icon md-icon"></span>
729
730
731
Guide
732
733
734
</label>
735
<ul class="md-nav__list" data-md-scrollfix>
736
737
738
739
740
741
742
743
<li class="md-nav__item">
744
<a href="../../guide/agent-registration/" class="md-nav__link">
745
746
747
748
<span class="md-ellipsis">
749
750
751
Agent Registration
752
753
754
755
</span>
756
757
758
759
</a>
760
</li>
761
762
763
764
765
766
767
768
769
770
771
<li class="md-nav__item">
772
<a href="../../guide/fleet-management/" class="md-nav__link">
773
774
775
776
<span class="md-ellipsis">
777
778
779
Fleet Management
780
781
782
783
</span>
784
785
786
787
</a>
788
</li>
789
790
791
792
793
794
795
796
797
798
799
<li class="md-nav__item">
800
<a href="../../guide/relays/" class="md-nav__link">
801
802
803
804
<span class="md-ellipsis">
805
806
807
Relay Brokers
808
809
810
811
</span>
812
813
814
815
</a>
816
</li>
817
818
819
820
821
822
823
824
825
826
827
<li class="md-nav__item">
828
<a href="../../guide/headless-agents/" class="md-nav__link">
829
830
831
832
<span class="md-ellipsis">
833
834
835
Headless Agents
836
837
838
839
</span>
840
841
842
843
</a>
844
</li>
845
846
847
848
849
850
851
852
853
854
855
<li class="md-nav__item">
856
<a href="../../guide/topology/" class="md-nav__link">
857
858
859
860
<span class="md-ellipsis">
861
862
863
Channel Topology
864
865
866
867
</span>
868
869
870
871
</a>
872
</li>
873
874
875
876
877
878
879
880
881
882
883
<li class="md-nav__item">
884
<a href="../../guide/bots/" class="md-nav__link">
885
886
887
888
<span class="md-ellipsis">
889
890
891
Built-in Bots
892
893
894
895
</span>
896
897
898
899
</a>
900
</li>
901
902
903
904
905
906
907
908
909
910
911
<li class="md-nav__item">
912
<a href="../../guide/discovery/" class="md-nav__link">
913
914
915
916
<span class="md-ellipsis">
917
918
919
Discovery
920
921
922
923
</span>
924
925
926
927
</a>
928
</li>
929
930
931
932
933
934
935
936
937
938
939
<li class="md-nav__item">
940
<a href="../../guide/deployment/" class="md-nav__link">
941
942
943
944
<span class="md-ellipsis">
945
946
947
Deployment
948
949
950
951
</span>
952
953
954
955
</a>
956
</li>
957
958
959
960
961
962
963
964
965
966
967
<li class="md-nav__item">
968
<a href="../../guide/adding-agents/" class="md-nav__link">
969
970
971
972
<span class="md-ellipsis">
973
974
975
Adding Agents
976
977
978
979
</span>
980
981
982
983
</a>
984
</li>
985
986
987
988
989
</ul>
990
</nav>
991
992
</li>
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
<li class="md-nav__item md-nav__item--nested">
1013
1014
1015
1016
1017
1018
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
1019
1020
1021
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1022
1023
1024
1025
<span class="md-ellipsis">
1026
1027
1028
Architecture
1029
1030
1031
1032
</span>
1033
1034
1035
1036
<span class="md-nav__icon md-icon"></span>
1037
</label>
1038
1039
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1040
<label class="md-nav__title" for="__nav_4">
1041
<span class="md-nav__icon md-icon"></span>
1042
1043
1044
Architecture
1045
1046
1047
</label>
1048
<ul class="md-nav__list" data-md-scrollfix>
1049
1050
1051
1052
1053
1054
1055
1056
<li class="md-nav__item">
1057
<a href="../../architecture/overview/" class="md-nav__link">
1058
1059
1060
1061
<span class="md-ellipsis">
1062
1063
1064
Overview
1065
1066
1067
1068
</span>
1069
1070
1071
1072
</a>
1073
</li>
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
<li class="md-nav__item">
1085
<a href="../../architecture/why-irc/" class="md-nav__link">
1086
1087
1088
1089
<span class="md-ellipsis">
1090
1091
1092
Why IRC
1093
1094
1095
1096
</span>
1097
1098
1099
1100
</a>
1101
</li>
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
<li class="md-nav__item">
1113
<a href="../../architecture/wire-format/" class="md-nav__link">
1114
1115
1116
1117
<span class="md-ellipsis">
1118
1119
1120
Wire Format
1121
1122
1123
1124
</span>
1125
1126
1127
1128
</a>
1129
</li>
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
<li class="md-nav__item">
1141
<a href="../../architecture/persistence/" class="md-nav__link">
1142
1143
1144
1145
<span class="md-ellipsis">
1146
1147
1148
Persistence
1149
1150
1151
1152
</span>
1153
1154
1155
1156
</a>
1157
</li>
1158
1159
1160
1161
1162
</ul>
1163
</nav>
1164
1165
</li>
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
<li class="md-nav__item md-nav__item--nested">
1186
1187
1188
1189
1190
1191
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
1192
1193
1194
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1195
1196
1197
1198
<span class="md-ellipsis">
1199
1200
1201
Reference
1202
1203
1204
1205
</span>
1206
1207
1208
1209
<span class="md-nav__icon md-icon"></span>
1210
</label>
1211
1212
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1213
<label class="md-nav__title" for="__nav_5">
1214
<span class="md-nav__icon md-icon"></span>
1215
1216
1217
Reference
1218
1219
1220
</label>
1221
<ul class="md-nav__list" data-md-scrollfix>
1222
1223
1224
1225
1226
1227
1228
1229
<li class="md-nav__item">
1230
<a href="../../reference/api/" class="md-nav__link">
1231
1232
1233
1234
<span class="md-ellipsis">
1235
1236
1237
HTTP API
1238
1239
1240
1241
</span>
1242
1243
1244
1245
</a>
1246
</li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
<li class="md-nav__item">
1258
<a href="../../reference/cli/" class="md-nav__link">
1259
1260
1261
1262
<span class="md-ellipsis">
1263
1264
1265
CLI (scuttlectl)
1266
1267
1268
1269
</span>
1270
1271
1272
1273
</a>
1274
</li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
<li class="md-nav__item">
1286
<a href="../../reference/config/" class="md-nav__link">
1287
1288
1289
1290
<span class="md-ellipsis">
1291
1292
1293
Config Schema
1294
1295
1296
1297
</span>
1298
1299
1300
1301
</a>
1302
</li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
<li class="md-nav__item">
1314
<a href="../../reference/message-types/" class="md-nav__link">
1315
1316
1317
1318
<span class="md-ellipsis">
1319
1320
1321
Message Types
1322
1323
1324
1325
</span>
1326
1327
1328
1329
</a>
1330
</li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
<li class="md-nav__item">
1342
<a href="../../reference/mcp/" class="md-nav__link">
1343
1344
1345
1346
<span class="md-ellipsis">
1347
1348
1349
MCP Server
1350
1351
1352
1353
</span>
1354
1355
1356
1357
</a>
1358
</li>
1359
1360
1361
1362
1363
</ul>
1364
</nav>
1365
1366
</li>
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
<li class="md-nav__item">
1377
<a href="../../contributing/" class="md-nav__link">
1378
1379
1380
1381
<span class="md-ellipsis">
1382
1383
1384
Contributing
1385
1386
1387
1388
</span>
1389
1390
1391
1392
</a>
1393
</li>
1394
1395
1396
1397
</ul>
1398
</nav>
1399
</div>
1400
</div>
1401
</div>
1402
1403
1404
1405
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1406
<div class="md-sidebar__scrollwrap">
1407
<div class="md-sidebar__inner">
1408
1409
1410
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1411
1412
1413
1414
1415
1416
1417
<label class="md-nav__title" for="__toc">
1418
<span class="md-nav__icon md-icon"></span>
1419
Table of contents
1420
</label>
1421
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1422
1423
<li class="md-nav__item">
1424
<a href="#binary-installation" class="md-nav__link">
1425
<span class="md-ellipsis">
1426
1427
Binary Installation
1428
1429
</span>
1430
</a>
1431
1432
</li>
1433
1434
<li class="md-nav__item">
1435
<a href="#building-from-source" class="md-nav__link">
1436
<span class="md-ellipsis">
1437
1438
Building from Source
1439
1440
</span>
1441
</a>
1442
1443
</li>
1444
1445
<li class="md-nav__item">
1446
<a href="#agent-relay-installation" class="md-nav__link">
1447
<span class="md-ellipsis">
1448
1449
Agent Relay Installation
1450
1451
</span>
1452
</a>
1453
1454
<nav class="md-nav" aria-label="Agent Relay Installation">
1455
<ul class="md-nav__list">
1456
1457
<li class="md-nav__item">
1458
<a href="#claude-code-relay" class="md-nav__link">
1459
<span class="md-ellipsis">
1460
1461
Claude Code Relay
1462
1463
</span>
1464
</a>
1465
1466
</li>
1467
1468
<li class="md-nav__item">
1469
<a href="#gemini-cli-relay" class="md-nav__link">
1470
<span class="md-ellipsis">
1471
1472
Gemini CLI Relay
1473
1474
</span>
1475
</a>
1476
1477
</li>
1478
1479
<li class="md-nav__item">
1480
<a href="#codex-openai-relay" class="md-nav__link">
1481
<span class="md-ellipsis">
1482
1483
Codex / OpenAI Relay
1484
1485
</span>
1486
</a>
1487
1488
</li>
1489
1490
</ul>
1491
</nav>
1492
1493
</li>
1494
1495
</ul>
1496
1497
</nav>
1498
</div>
1499
</div>
1500
</div>
1501
1502
1503
1504
<div class="md-content" data-md-component="content">
1505
1506
<article class="md-content__inner md-typeset">
1507
1508
1509
1510
1511
1512
1513
1514
1515
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h1>
1516
<p>scuttlebot is distributed as a single Go binary that manages its own IRC server (Ergo).</p>
1517
<h2 id="binary-installation">Binary Installation<a class="headerlink" href="#binary-installation" title="Permanent link">&para;</a></h2>
1518
<p>The fastest way to install the daemon and the control CLI is via our install script:</p>
1519
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://scuttlebot.dev/install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
1520
</code></pre></div>
1521
<p>This installs <code>scuttlebot</code> and <code>scuttlectl</code> to <code>/usr/local/bin</code>.</p>
1522
<h2 id="building-from-source">Building from Source<a class="headerlink" href="#building-from-source" title="Permanent link">&para;</a></h2>
1523
<p>If you have Go 1.22+ installed, you can build all components from the repository:</p>
1524
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ConflictHQ/scuttlebot
1525
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nb">cd</span><span class="w"> </span>scuttlebot
1526
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>make<span class="w"> </span>build
1527
</code></pre></div>
1528
<p>This produces the following binaries in <code>bin/</code>:
1529
- <code>scuttlebot</code>: The main daemon
1530
- <code>scuttlectl</code>: Administrative CLI
1531
- <code>claude-agent</code>, <code>codex-agent</code>, <code>gemini-agent</code>: Standalone IRC bots
1532
- <code>fleet-cmd</code>: Multi-session management tool</p>
1533
<h2 id="agent-relay-installation">Agent Relay Installation<a class="headerlink" href="#agent-relay-installation" title="Permanent link">&para;</a></h2>
1534
<p>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.</p>
1535
<p>By default, the relay installers configure the interactive broker pattern:
1536
- local CLI wrapped in a PTY broker
1537
- IRC-visible <code>online</code> / <code>offline</code> presence
1538
- live operator message injection from IRC
1539
- default IRC auth via ephemeral auto-registration when transport is <code>irc</code>
1540
- fixed NickServ passwords only when you explicitly opt into <code>--irc-pass</code></p>
1541
<h3 id="claude-code-relay">Claude Code Relay<a class="headerlink" href="#claude-code-relay" title="Permanent link">&para;</a></h3>
1542
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nv">SCUTTLEBOT_URL</span><span class="o">=</span>http://localhost:8080<span class="w"> </span><span class="se">\</span>
1543
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nv">SCUTTLEBOT_TOKEN</span><span class="o">=</span><span class="s2">&quot;your-token&quot;</span><span class="w"> </span><span class="se">\</span>
1544
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="nv">SCUTTLEBOT_CHANNEL</span><span class="o">=</span>general<span class="w"> </span><span class="se">\</span>
1545
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>make<span class="w"> </span>install-claude-relay
1546
</code></pre></div>
1547
<h3 id="gemini-cli-relay">Gemini CLI Relay<a class="headerlink" href="#gemini-cli-relay" title="Permanent link">&para;</a></h3>
1548
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nv">SCUTTLEBOT_URL</span><span class="o">=</span>http://localhost:8080<span class="w"> </span><span class="se">\</span>
1549
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="nv">SCUTTLEBOT_TOKEN</span><span class="o">=</span><span class="s2">&quot;your-token&quot;</span><span class="w"> </span><span class="se">\</span>
1550
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="nv">SCUTTLEBOT_CHANNEL</span><span class="o">=</span>general<span class="w"> </span><span class="se">\</span>
1551
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>make<span class="w"> </span>install-gemini-relay
1552
</code></pre></div>
1553
<h3 id="codex-openai-relay">Codex / OpenAI Relay<a class="headerlink" href="#codex-openai-relay" title="Permanent link">&para;</a></h3>
1554
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nv">SCUTTLEBOT_URL</span><span class="o">=</span>http://localhost:8080<span class="w"> </span><span class="se">\</span>
1555
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nv">SCUTTLEBOT_TOKEN</span><span class="o">=</span><span class="s2">&quot;your-token&quot;</span><span class="w"> </span><span class="se">\</span>
1556
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="nv">SCUTTLEBOT_CHANNEL</span><span class="o">=</span>general<span class="w"> </span><span class="se">\</span>
1557
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>make<span class="w"> </span>install-codex-relay
1558
</code></pre></div>
1559
<p>These installers set up the interactive broker, PTY wrappers, and tool-use hooks automatically.
1560
Installed files under <code>~/.claude/</code>, <code>~/.codex/</code>, <code>~/.gemini/</code>, <code>~/.local/bin/</code>, and
1561
<code>~/.config/</code> are generated copies. The repo docs remain the source of truth.</p>
1562
<p>For detailed relay setup and fleet configuration:</p>
1563
<ul>
1564
<li><a href="../../guide/relays/">Relay Brokers guide</a> — env vars, transport modes, troubleshooting</li>
1565
<li><a href="../../guide/adding-agents/">Adding Agents guide</a> — canonical broker pattern for new runtimes</li>
1566
</ul>
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
</article>
1581
</div>
1582
1583
1584
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
1585
1586
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1587
</div>
1588
1589
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1590
1591
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
1592
Back to top
1593
</button>
1594
1595
</main>
1596
1597
<footer class="md-footer">
1598
1599
<div class="md-footer-meta md-typeset">
1600
<div class="md-footer-meta__inner md-grid">
1601
<div class="md-copyright">
1602
1603
<div class="md-copyright__highlight">
1604
Copyright &copy; 2026 CONFLICT LLC
1605
</div>
1606
1607
1608
Made with
1609
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1610
Material for MkDocs
1611
</a>
1612
1613
</div>
1614
1615
1616
<div class="md-social">
1617
1618
1619
1620
1621
1622
1623
1624
1625
<a href="https://github.com/ConflictHQ/scuttlebot" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1626
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
1627
</a>
1628
1629
</div>
1630
1631
</div>
1632
</div>
1633
</footer>
1634
1635
</div>
1636
<div class="md-dialog" data-md-component="dialog">
1637
<div class="md-dialog__inner md-typeset"></div>
1638
</div>
1639
1640
1641
1642
1643
1644
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
1645
1646
1647
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1648
1649
1650
</body>
1651
</html>

Keyboard Shortcuts

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