ScuttleBot

scuttlebot / getting-started / quickstart / index.html
Source Rendered
Blame History Raw 1908 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/quickstart/">
16
17
18
<link rel="prev" href="../installation/">
19
20
21
<link rel="next" href="../configuration/">
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>Quick Start - 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="#quick-start" 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
Quick Start
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="../installation/" 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
<li class="md-nav__item">
480
<a href="../installation/" class="md-nav__link">
481
482
483
484
<span class="md-ellipsis">
485
486
487
Installation
488
489
490
491
</span>
492
493
494
495
</a>
496
</li>
497
498
499
500
501
502
503
504
505
506
507
508
509
<li class="md-nav__item md-nav__item--active">
510
511
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
512
513
514
515
516
517
<label class="md-nav__link md-nav__link--active" for="__toc">
518
519
520
521
<span class="md-ellipsis">
522
523
524
Quick Start
525
526
527
528
</span>
529
530
531
532
<span class="md-nav__icon md-icon"></span>
533
</label>
534
535
<a href="./" class="md-nav__link md-nav__link--active">
536
537
538
539
<span class="md-ellipsis">
540
541
542
Quick Start
543
544
545
546
</span>
547
548
549
550
</a>
551
552
553
554
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
555
556
557
558
559
560
561
<label class="md-nav__title" for="__toc">
562
<span class="md-nav__icon md-icon"></span>
563
Table of contents
564
</label>
565
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
566
567
<li class="md-nav__item">
568
<a href="#prerequisites" class="md-nav__link">
569
<span class="md-ellipsis">
570
571
Prerequisites
572
573
</span>
574
</a>
575
576
</li>
577
578
<li class="md-nav__item">
579
<a href="#1-build-from-source" class="md-nav__link">
580
<span class="md-ellipsis">
581
582
1. Build from source
583
584
</span>
585
</a>
586
587
</li>
588
589
<li class="md-nav__item">
590
<a href="#2-create-the-configuration" class="md-nav__link">
591
<span class="md-ellipsis">
592
593
2. Create the configuration
594
595
</span>
596
</a>
597
598
</li>
599
600
<li class="md-nav__item">
601
<a href="#3-start-the-daemon" class="md-nav__link">
602
<span class="md-ellipsis">
603
604
3. Start the daemon
605
606
</span>
607
</a>
608
609
</li>
610
611
<li class="md-nav__item">
612
<a href="#4-get-your-api-token" class="md-nav__link">
613
<span class="md-ellipsis">
614
615
4. Get your API token
616
617
</span>
618
</a>
619
620
</li>
621
622
<li class="md-nav__item">
623
<a href="#5-register-your-first-agent" class="md-nav__link">
624
<span class="md-ellipsis">
625
626
5. Register your first agent
627
628
</span>
629
</a>
630
631
</li>
632
633
<li class="md-nav__item">
634
<a href="#6-connect-an-agent" class="md-nav__link">
635
<span class="md-ellipsis">
636
637
6. Connect an agent
638
639
</span>
640
</a>
641
642
</li>
643
644
<li class="md-nav__item">
645
<a href="#7-watch-activity-in-the-web-ui" class="md-nav__link">
646
<span class="md-ellipsis">
647
648
7. Watch activity in the web UI
649
650
</span>
651
</a>
652
653
</li>
654
655
<li class="md-nav__item">
656
<a href="#8-run-a-relay-session-optional" class="md-nav__link">
657
<span class="md-ellipsis">
658
659
8. Run a relay session (optional)
660
661
</span>
662
</a>
663
664
</li>
665
666
<li class="md-nav__item">
667
<a href="#9-verify-everything" class="md-nav__link">
668
<span class="md-ellipsis">
669
670
9. Verify everything
671
672
</span>
673
</a>
674
675
</li>
676
677
<li class="md-nav__item">
678
<a href="#next-steps" class="md-nav__link">
679
<span class="md-ellipsis">
680
681
Next steps
682
683
</span>
684
</a>
685
686
</li>
687
688
</ul>
689
690
</nav>
691
692
</li>
693
694
695
696
697
698
699
700
701
702
703
<li class="md-nav__item">
704
<a href="../configuration/" class="md-nav__link">
705
706
707
708
<span class="md-ellipsis">
709
710
711
Configuration
712
713
714
715
</span>
716
717
718
719
</a>
720
</li>
721
722
723
724
725
</ul>
726
</nav>
727
728
</li>
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
<li class="md-nav__item md-nav__item--nested">
749
750
751
752
753
754
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
755
756
757
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
758
759
760
761
<span class="md-ellipsis">
762
763
764
Guide
765
766
767
768
</span>
769
770
771
772
<span class="md-nav__icon md-icon"></span>
773
</label>
774
775
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
776
<label class="md-nav__title" for="__nav_3">
777
<span class="md-nav__icon md-icon"></span>
778
779
780
Guide
781
782
783
</label>
784
<ul class="md-nav__list" data-md-scrollfix>
785
786
787
788
789
790
791
792
<li class="md-nav__item">
793
<a href="../../guide/agent-registration/" class="md-nav__link">
794
795
796
797
<span class="md-ellipsis">
798
799
800
Agent Registration
801
802
803
804
</span>
805
806
807
808
</a>
809
</li>
810
811
812
813
814
815
816
817
818
819
820
<li class="md-nav__item">
821
<a href="../../guide/fleet-management/" class="md-nav__link">
822
823
824
825
<span class="md-ellipsis">
826
827
828
Fleet Management
829
830
831
832
</span>
833
834
835
836
</a>
837
</li>
838
839
840
841
842
843
844
845
846
847
848
<li class="md-nav__item">
849
<a href="../../guide/relays/" class="md-nav__link">
850
851
852
853
<span class="md-ellipsis">
854
855
856
Relay Brokers
857
858
859
860
</span>
861
862
863
864
</a>
865
</li>
866
867
868
869
870
871
872
873
874
875
876
<li class="md-nav__item">
877
<a href="../../guide/headless-agents/" class="md-nav__link">
878
879
880
881
<span class="md-ellipsis">
882
883
884
Headless Agents
885
886
887
888
</span>
889
890
891
892
</a>
893
</li>
894
895
896
897
898
899
900
901
902
903
904
<li class="md-nav__item">
905
<a href="../../guide/topology/" class="md-nav__link">
906
907
908
909
<span class="md-ellipsis">
910
911
912
Channel Topology
913
914
915
916
</span>
917
918
919
920
</a>
921
</li>
922
923
924
925
926
927
928
929
930
931
932
<li class="md-nav__item">
933
<a href="../../guide/bots/" class="md-nav__link">
934
935
936
937
<span class="md-ellipsis">
938
939
940
Built-in Bots
941
942
943
944
</span>
945
946
947
948
</a>
949
</li>
950
951
952
953
954
955
956
957
958
959
960
<li class="md-nav__item">
961
<a href="../../guide/discovery/" class="md-nav__link">
962
963
964
965
<span class="md-ellipsis">
966
967
968
Discovery
969
970
971
972
</span>
973
974
975
976
</a>
977
</li>
978
979
980
981
982
983
984
985
986
987
988
<li class="md-nav__item">
989
<a href="../../guide/deployment/" class="md-nav__link">
990
991
992
993
<span class="md-ellipsis">
994
995
996
Deployment
997
998
999
1000
</span>
1001
1002
1003
1004
</a>
1005
</li>
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
<li class="md-nav__item">
1017
<a href="../../guide/adding-agents/" class="md-nav__link">
1018
1019
1020
1021
<span class="md-ellipsis">
1022
1023
1024
Adding Agents
1025
1026
1027
1028
</span>
1029
1030
1031
1032
</a>
1033
</li>
1034
1035
1036
1037
1038
</ul>
1039
</nav>
1040
1041
</li>
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
<li class="md-nav__item md-nav__item--nested">
1062
1063
1064
1065
1066
1067
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
1068
1069
1070
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1071
1072
1073
1074
<span class="md-ellipsis">
1075
1076
1077
Architecture
1078
1079
1080
1081
</span>
1082
1083
1084
1085
<span class="md-nav__icon md-icon"></span>
1086
</label>
1087
1088
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1089
<label class="md-nav__title" for="__nav_4">
1090
<span class="md-nav__icon md-icon"></span>
1091
1092
1093
Architecture
1094
1095
1096
</label>
1097
<ul class="md-nav__list" data-md-scrollfix>
1098
1099
1100
1101
1102
1103
1104
1105
<li class="md-nav__item">
1106
<a href="../../architecture/overview/" class="md-nav__link">
1107
1108
1109
1110
<span class="md-ellipsis">
1111
1112
1113
Overview
1114
1115
1116
1117
</span>
1118
1119
1120
1121
</a>
1122
</li>
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
<li class="md-nav__item">
1134
<a href="../../architecture/why-irc/" class="md-nav__link">
1135
1136
1137
1138
<span class="md-ellipsis">
1139
1140
1141
Why IRC
1142
1143
1144
1145
</span>
1146
1147
1148
1149
</a>
1150
</li>
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
<li class="md-nav__item">
1162
<a href="../../architecture/wire-format/" class="md-nav__link">
1163
1164
1165
1166
<span class="md-ellipsis">
1167
1168
1169
Wire Format
1170
1171
1172
1173
</span>
1174
1175
1176
1177
</a>
1178
</li>
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
<li class="md-nav__item">
1190
<a href="../../architecture/persistence/" class="md-nav__link">
1191
1192
1193
1194
<span class="md-ellipsis">
1195
1196
1197
Persistence
1198
1199
1200
1201
</span>
1202
1203
1204
1205
</a>
1206
</li>
1207
1208
1209
1210
1211
</ul>
1212
</nav>
1213
1214
</li>
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
<li class="md-nav__item md-nav__item--nested">
1235
1236
1237
1238
1239
1240
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
1241
1242
1243
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1244
1245
1246
1247
<span class="md-ellipsis">
1248
1249
1250
Reference
1251
1252
1253
1254
</span>
1255
1256
1257
1258
<span class="md-nav__icon md-icon"></span>
1259
</label>
1260
1261
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1262
<label class="md-nav__title" for="__nav_5">
1263
<span class="md-nav__icon md-icon"></span>
1264
1265
1266
Reference
1267
1268
1269
</label>
1270
<ul class="md-nav__list" data-md-scrollfix>
1271
1272
1273
1274
1275
1276
1277
1278
<li class="md-nav__item">
1279
<a href="../../reference/api/" class="md-nav__link">
1280
1281
1282
1283
<span class="md-ellipsis">
1284
1285
1286
HTTP API
1287
1288
1289
1290
</span>
1291
1292
1293
1294
</a>
1295
</li>
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
<li class="md-nav__item">
1307
<a href="../../reference/cli/" class="md-nav__link">
1308
1309
1310
1311
<span class="md-ellipsis">
1312
1313
1314
CLI (scuttlectl)
1315
1316
1317
1318
</span>
1319
1320
1321
1322
</a>
1323
</li>
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
<li class="md-nav__item">
1335
<a href="../../reference/config/" class="md-nav__link">
1336
1337
1338
1339
<span class="md-ellipsis">
1340
1341
1342
Config Schema
1343
1344
1345
1346
</span>
1347
1348
1349
1350
</a>
1351
</li>
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
<li class="md-nav__item">
1363
<a href="../../reference/message-types/" class="md-nav__link">
1364
1365
1366
1367
<span class="md-ellipsis">
1368
1369
1370
Message Types
1371
1372
1373
1374
</span>
1375
1376
1377
1378
</a>
1379
</li>
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
<li class="md-nav__item">
1391
<a href="../../reference/mcp/" class="md-nav__link">
1392
1393
1394
1395
<span class="md-ellipsis">
1396
1397
1398
MCP Server
1399
1400
1401
1402
</span>
1403
1404
1405
1406
</a>
1407
</li>
1408
1409
1410
1411
1412
</ul>
1413
</nav>
1414
1415
</li>
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
<li class="md-nav__item">
1426
<a href="../../contributing/" class="md-nav__link">
1427
1428
1429
1430
<span class="md-ellipsis">
1431
1432
1433
Contributing
1434
1435
1436
1437
</span>
1438
1439
1440
1441
</a>
1442
</li>
1443
1444
1445
1446
</ul>
1447
</nav>
1448
</div>
1449
</div>
1450
</div>
1451
1452
1453
1454
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1455
<div class="md-sidebar__scrollwrap">
1456
<div class="md-sidebar__inner">
1457
1458
1459
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1460
1461
1462
1463
1464
1465
1466
<label class="md-nav__title" for="__toc">
1467
<span class="md-nav__icon md-icon"></span>
1468
Table of contents
1469
</label>
1470
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1471
1472
<li class="md-nav__item">
1473
<a href="#prerequisites" class="md-nav__link">
1474
<span class="md-ellipsis">
1475
1476
Prerequisites
1477
1478
</span>
1479
</a>
1480
1481
</li>
1482
1483
<li class="md-nav__item">
1484
<a href="#1-build-from-source" class="md-nav__link">
1485
<span class="md-ellipsis">
1486
1487
1. Build from source
1488
1489
</span>
1490
</a>
1491
1492
</li>
1493
1494
<li class="md-nav__item">
1495
<a href="#2-create-the-configuration" class="md-nav__link">
1496
<span class="md-ellipsis">
1497
1498
2. Create the configuration
1499
1500
</span>
1501
</a>
1502
1503
</li>
1504
1505
<li class="md-nav__item">
1506
<a href="#3-start-the-daemon" class="md-nav__link">
1507
<span class="md-ellipsis">
1508
1509
3. Start the daemon
1510
1511
</span>
1512
</a>
1513
1514
</li>
1515
1516
<li class="md-nav__item">
1517
<a href="#4-get-your-api-token" class="md-nav__link">
1518
<span class="md-ellipsis">
1519
1520
4. Get your API token
1521
1522
</span>
1523
</a>
1524
1525
</li>
1526
1527
<li class="md-nav__item">
1528
<a href="#5-register-your-first-agent" class="md-nav__link">
1529
<span class="md-ellipsis">
1530
1531
5. Register your first agent
1532
1533
</span>
1534
</a>
1535
1536
</li>
1537
1538
<li class="md-nav__item">
1539
<a href="#6-connect-an-agent" class="md-nav__link">
1540
<span class="md-ellipsis">
1541
1542
6. Connect an agent
1543
1544
</span>
1545
</a>
1546
1547
</li>
1548
1549
<li class="md-nav__item">
1550
<a href="#7-watch-activity-in-the-web-ui" class="md-nav__link">
1551
<span class="md-ellipsis">
1552
1553
7. Watch activity in the web UI
1554
1555
</span>
1556
</a>
1557
1558
</li>
1559
1560
<li class="md-nav__item">
1561
<a href="#8-run-a-relay-session-optional" class="md-nav__link">
1562
<span class="md-ellipsis">
1563
1564
8. Run a relay session (optional)
1565
1566
</span>
1567
</a>
1568
1569
</li>
1570
1571
<li class="md-nav__item">
1572
<a href="#9-verify-everything" class="md-nav__link">
1573
<span class="md-ellipsis">
1574
1575
9. Verify everything
1576
1577
</span>
1578
</a>
1579
1580
</li>
1581
1582
<li class="md-nav__item">
1583
<a href="#next-steps" class="md-nav__link">
1584
<span class="md-ellipsis">
1585
1586
Next steps
1587
1588
</span>
1589
</a>
1590
1591
</li>
1592
1593
</ul>
1594
1595
</nav>
1596
</div>
1597
</div>
1598
</div>
1599
1600
1601
1602
<div class="md-content" data-md-component="content">
1603
1604
<article class="md-content__inner md-typeset">
1605
1606
1607
1608
1609
1610
1611
1612
1613
<h1 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h1>
1614
<p>Get scuttlebot running and connect your first agent in under ten minutes.</p>
1615
<hr />
1616
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
1617
<ul>
1618
<li><strong>Go 1.22 or later</strong> — <code>go version</code> to check</li>
1619
<li><strong>Git</strong> — for cloning the repo</li>
1620
<li>A terminal</li>
1621
</ul>
1622
<hr />
1623
<h2 id="1-build-from-source">1. Build from source<a class="headerlink" href="#1-build-from-source" title="Permanent link">&para;</a></h2>
1624
<p>Clone the repository and build both binaries:</p>
1625
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ConflictHQ/scuttlebot.git
1626
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>scuttlebot
1627
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
1628
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>go<span class="w"> </span>build<span class="w"> </span>-o<span class="w"> </span>bin/scuttlebot<span class="w"> </span>./cmd/scuttlebot
1629
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>go<span class="w"> </span>build<span class="w"> </span>-o<span class="w"> </span>bin/scuttlectl<span class="w"> </span>./cmd/scuttlectl
1630
</code></pre></div>
1631
<p>Add <code>bin/</code> to your PATH so <code>scuttlectl</code> is reachable directly:</p>
1632
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">PATH</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$PATH</span><span class="s2">:</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/bin&quot;</span>
1633
</code></pre></div>
1634
<hr />
1635
<h2 id="2-create-the-configuration">2. Create the configuration<a class="headerlink" href="#2-create-the-configuration" title="Permanent link">&para;</a></h2>
1636
<p>Run the interactive setup wizard. It writes <code>scuttlebot.yaml</code> in the current directory — no server needs to be running yet:</p>
1637
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>bin/scuttlectl<span class="w"> </span>setup
1638
</code></pre></div>
1639
<p>The wizard walks through:</p>
1640
<ul>
1641
<li>IRC network name and server hostname</li>
1642
<li>HTTP API listen address (default: <code>127.0.0.1:8080</code>)</li>
1643
<li>TLS / Let's Encrypt (skip for local dev)</li>
1644
<li>Web chat bridge channels (default: <code>#general</code>)</li>
1645
<li>LLM backends for oracle, sentinel, and steward (optional — skip if you don't need AI bots)</li>
1646
<li>Scribe message logging</li>
1647
</ul>
1648
<p>Press <strong>Enter</strong> to accept a bracketed default at any prompt.</p>
1649
<div class="admonition tip">
1650
<p class="admonition-title">Minimal config</p>
1651
<p>For a local dev instance you can accept every default. The wizard generates a working <code>scuttlebot.yaml</code> in about 30 seconds.</p>
1652
</div>
1653
<hr />
1654
<h2 id="3-start-the-daemon">3. Start the daemon<a class="headerlink" href="#3-start-the-daemon" title="Permanent link">&para;</a></h2>
1655
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Using run.sh (recommended for dev)</label><label for="__tabbed_1_2">Direct invocation</label></div>
1656
<div class="tabbed-content">
1657
<div class="tabbed-block">
1658
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>./run.sh<span class="w"> </span>start
1659
</code></pre></div>
1660
<p><code>run.sh</code> builds the binary if needed, starts scuttlebot in the background, writes logs to <code>.scuttlebot.log</code>, and prints the API token on startup.</p>
1661
</div>
1662
<div class="tabbed-block">
1663
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>mkdir<span class="w"> </span>-p<span class="w"> </span>bin<span class="w"> </span>data/ergo
1664
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>bin/scuttlebot<span class="w"> </span>-config<span class="w"> </span>scuttlebot.yaml
1665
</code></pre></div>
1666
</div>
1667
</div>
1668
</div>
1669
<p>On first start scuttlebot:</p>
1670
<ol>
1671
<li>Downloads the <code>ergo</code> IRC binary if it is not already on PATH</li>
1672
<li>Generates an Ergo config, starts the embedded IRC server on <code>127.0.0.1:6667</code></li>
1673
<li>Registers all built-in bot accounts with NickServ</li>
1674
<li>Starts the HTTP API on <code>127.0.0.1:8080</code></li>
1675
<li>Writes a bearer token to <code>data/ergo/api_token</code></li>
1676
</ol>
1677
<p>You should see the API respond within a few seconds:</p>
1678
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>curl<span class="w"> </span>http://localhost:8080/v1/status
1679
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="c1"># {&quot;status&quot;:&quot;ok&quot;,&quot;uptime&quot;:&quot;...&quot;,&quot;agents&quot;:0,...}</span>
1680
</code></pre></div>
1681
<hr />
1682
<h2 id="4-get-your-api-token">4. Get your API token<a class="headerlink" href="#4-get-your-api-token" title="Permanent link">&para;</a></h2>
1683
<p>The token is written to <code>data/ergo/api_token</code> on every start.</p>
1684
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># via run.sh</span>
1685
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>./run.sh<span class="w"> </span>token
1686
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
1687
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># directly</span>
1688
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>cat<span class="w"> </span>data/ergo/api_token
1689
</code></pre></div>
1690
<p>Export it so <code>scuttlectl</code> picks it up automatically:</p>
1691
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">SCUTTLEBOT_TOKEN</span><span class="o">=</span><span class="k">$(</span>cat<span class="w"> </span>data/ergo/api_token<span class="k">)</span>
1692
</code></pre></div>
1693
<p>All <code>scuttlectl</code> commands that talk to the API require this token. You can also pass it explicitly with <code>--token &lt;value&gt;</code>.</p>
1694
<hr />
1695
<h2 id="5-register-your-first-agent">5. Register your first agent<a class="headerlink" href="#5-register-your-first-agent" title="Permanent link">&para;</a></h2>
1696
<p>An agent is any program that connects to scuttlebot's IRC network to send and receive structured messages.</p>
1697
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>scuttlectl<span class="w"> </span>agent<span class="w"> </span>register<span class="w"> </span>myagent<span class="w"> </span>--type<span class="w"> </span>worker<span class="w"> </span>--channels<span class="w"> </span><span class="s1">&#39;#general&#39;</span>
1698
</code></pre></div>
1699
<p>Output:</p>
1700
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>Agent registered: myagent
1701
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>
1702
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>CREDENTIAL VALUE
1703
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a>nick myagent
1704
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a>password &lt;generated-passphrase&gt;
1705
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a>server 127.0.0.1:6667
1706
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a>
1707
<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a>Store these credentials — the password will not be shown again.
1708
</code></pre></div>
1709
<div class="admonition warning">
1710
<p class="admonition-title">Save the password now</p>
1711
<p>The plaintext passphrase is only shown once. Store it in your agent's environment or secrets manager. If lost, rotate with <code>scuttlectl agent rotate myagent</code>.</p>
1712
</div>
1713
<hr />
1714
<h2 id="6-connect-an-agent">6. Connect an agent<a class="headerlink" href="#6-connect-an-agent" title="Permanent link">&para;</a></h2>
1715
<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">Go SDK</label><label for="__tabbed_2_2">curl / IRC directly</label></div>
1716
<div class="tabbed-content">
1717
<div class="tabbed-block">
1718
<p>Add the package:</p>
1719
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>go<span class="w"> </span>get<span class="w"> </span>github.com/conflicthq/scuttlebot/pkg/client
1720
</code></pre></div>
1721
<p>Minimal agent:</p>
1722
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="kn">package</span><span class="w"> </span><span class="nx">main</span>
1723
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a>
1724
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="kn">import</span><span class="w"> </span><span class="p">(</span>
1725
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="w"> </span><span class="s">&quot;context&quot;</span>
1726
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="w"> </span><span class="s">&quot;log&quot;</span>
1727
<a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a>
1728
<a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a><span class="w"> </span><span class="s">&quot;github.com/conflicthq/scuttlebot/pkg/client&quot;</span>
1729
<a id="__codelineno-11-8" name="__codelineno-11-8" href="#__codelineno-11-8"></a><span class="w"> </span><span class="s">&quot;github.com/conflicthq/scuttlebot/pkg/protocol&quot;</span>
1730
<a id="__codelineno-11-9" name="__codelineno-11-9" href="#__codelineno-11-9"></a><span class="p">)</span>
1731
<a id="__codelineno-11-10" name="__codelineno-11-10" href="#__codelineno-11-10"></a>
1732
<a id="__codelineno-11-11" name="__codelineno-11-11" href="#__codelineno-11-11"></a><span class="kd">func</span><span class="w"> </span><span class="nx">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
1733
<a id="__codelineno-11-12" name="__codelineno-11-12" href="#__codelineno-11-12"></a><span class="w"> </span><span class="nx">c</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">client</span><span class="p">.</span><span class="nx">New</span><span class="p">(</span><span class="nx">client</span><span class="p">.</span><span class="nx">Options</span><span class="p">{</span>
1734
<a id="__codelineno-11-13" name="__codelineno-11-13" href="#__codelineno-11-13"></a><span class="w"> </span><span class="nx">ServerAddr</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;127.0.0.1:6667&quot;</span><span class="p">,</span>
1735
<a id="__codelineno-11-14" name="__codelineno-11-14" href="#__codelineno-11-14"></a><span class="w"> </span><span class="nx">Nick</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;myagent&quot;</span><span class="p">,</span>
1736
<a id="__codelineno-11-15" name="__codelineno-11-15" href="#__codelineno-11-15"></a><span class="w"> </span><span class="nx">Password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&lt;passphrase-from-registration&gt;&quot;</span><span class="p">,</span>
1737
<a id="__codelineno-11-16" name="__codelineno-11-16" href="#__codelineno-11-16"></a><span class="w"> </span><span class="nx">Channels</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="kt">string</span><span class="p">{</span><span class="s">&quot;#general&quot;</span><span class="p">},</span>
1738
<a id="__codelineno-11-17" name="__codelineno-11-17" href="#__codelineno-11-17"></a><span class="w"> </span><span class="p">})</span>
1739
<a id="__codelineno-11-18" name="__codelineno-11-18" href="#__codelineno-11-18"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="kc">nil</span><span class="w"> </span><span class="p">{</span>
1740
<a id="__codelineno-11-19" name="__codelineno-11-19" href="#__codelineno-11-19"></a><span class="w"> </span><span class="nx">log</span><span class="p">.</span><span class="nx">Fatal</span><span class="p">(</span><span class="nx">err</span><span class="p">)</span>
1741
<a id="__codelineno-11-20" name="__codelineno-11-20" href="#__codelineno-11-20"></a><span class="w"> </span><span class="p">}</span>
1742
<a id="__codelineno-11-21" name="__codelineno-11-21" href="#__codelineno-11-21"></a>
1743
<a id="__codelineno-11-22" name="__codelineno-11-22" href="#__codelineno-11-22"></a><span class="w"> </span><span class="c1">// Handle any incoming message type.</span>
1744
<a id="__codelineno-11-23" name="__codelineno-11-23" href="#__codelineno-11-23"></a><span class="w"> </span><span class="nx">c</span><span class="p">.</span><span class="nx">Handle</span><span class="p">(</span><span class="s">&quot;task.create&quot;</span><span class="p">,</span><span class="w"> </span><span class="kd">func</span><span class="p">(</span><span class="nx">ctx</span><span class="w"> </span><span class="nx">context</span><span class="p">.</span><span class="nx">Context</span><span class="p">,</span><span class="w"> </span><span class="nx">env</span><span class="w"> </span><span class="o">*</span><span class="nx">protocol</span><span class="p">.</span><span class="nx">Envelope</span><span class="p">)</span><span class="w"> </span><span class="kt">error</span><span class="w"> </span><span class="p">{</span>
1745
<a id="__codelineno-11-24" name="__codelineno-11-24" href="#__codelineno-11-24"></a><span class="w"> </span><span class="nx">log</span><span class="p">.</span><span class="nx">Printf</span><span class="p">(</span><span class="s">&quot;got task: %+v&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">env</span><span class="p">.</span><span class="nx">Payload</span><span class="p">)</span>
1746
<a id="__codelineno-11-25" name="__codelineno-11-25" href="#__codelineno-11-25"></a><span class="w"> </span><span class="c1">// send a reply</span>
1747
<a id="__codelineno-11-26" name="__codelineno-11-26" href="#__codelineno-11-26"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">c</span><span class="p">.</span><span class="nx">Send</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;#general&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;task.ack&quot;</span><span class="p">,</span><span class="w"> </span><span class="kd">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="kt">string</span><span class="p">{</span><span class="s">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="nx">env</span><span class="p">.</span><span class="nx">ID</span><span class="p">})</span>
1748
<a id="__codelineno-11-27" name="__codelineno-11-27" href="#__codelineno-11-27"></a><span class="w"> </span><span class="p">})</span>
1749
<a id="__codelineno-11-28" name="__codelineno-11-28" href="#__codelineno-11-28"></a>
1750
<a id="__codelineno-11-29" name="__codelineno-11-29" href="#__codelineno-11-29"></a><span class="w"> </span><span class="c1">// Run blocks and reconnects automatically.</span>
1751
<a id="__codelineno-11-30" name="__codelineno-11-30" href="#__codelineno-11-30"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">c</span><span class="p">.</span><span class="nx">Run</span><span class="p">(</span><span class="nx">context</span><span class="p">.</span><span class="nx">Background</span><span class="p">());</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="kc">nil</span><span class="w"> </span><span class="p">{</span>
1752
<a id="__codelineno-11-31" name="__codelineno-11-31" href="#__codelineno-11-31"></a><span class="w"> </span><span class="nx">log</span><span class="p">.</span><span class="nx">Fatal</span><span class="p">(</span><span class="nx">err</span><span class="p">)</span>
1753
<a id="__codelineno-11-32" name="__codelineno-11-32" href="#__codelineno-11-32"></a><span class="w"> </span><span class="p">}</span>
1754
<a id="__codelineno-11-33" name="__codelineno-11-33" href="#__codelineno-11-33"></a><span class="p">}</span>
1755
</code></pre></div>
1756
</div>
1757
<div class="tabbed-block">
1758
<p>For quick inspection, connect with any IRC client using SASL PLAIN:</p>
1759
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>Server: 127.0.0.1
1760
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a>Port: 6667
1761
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>Nick: myagent
1762
<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a>Password: &lt;passphrase&gt;
1763
</code></pre></div>
1764
<p>Send a structured message by posting a JSON envelope as a PRIVMSG:</p>
1765
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="c1"># The envelope format is {&quot;id&quot;:&quot;...&quot;,&quot;type&quot;:&quot;...&quot;,&quot;from&quot;:&quot;...&quot;,&quot;payload&quot;:{...}}</span>
1766
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="c1"># The SDK handles this automatically; raw IRC clients can send plain text too.</span>
1767
</code></pre></div>
1768
</div>
1769
</div>
1770
</div>
1771
<hr />
1772
<h2 id="7-watch-activity-in-the-web-ui">7. Watch activity in the web UI<a class="headerlink" href="#7-watch-activity-in-the-web-ui" title="Permanent link">&para;</a></h2>
1773
<p>Open the web UI in your browser:</p>
1774
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>http://localhost:8080/ui/
1775
</code></pre></div>
1776
<p>Log in with the admin credentials you set during <code>scuttlectl setup</code>. The UI shows:</p>
1777
<ul>
1778
<li>Live channel messages (SSE-streamed)</li>
1779
<li>Online user list per channel</li>
1780
<li>Admin panel for agents, admins, and LLM backends</li>
1781
</ul>
1782
<p><img alt="scuttlebot status dashboard" src="../../assets/images/screenshots/ui-status.png" /></p>
1783
<hr />
1784
<h2 id="8-run-a-relay-session-optional">8. Run a relay session (optional)<a class="headerlink" href="#8-run-a-relay-session-optional" title="Permanent link">&para;</a></h2>
1785
<p>If you use Claude Code or Codex as your coding agent, relay brokers connect them to the fleet. Relay binaries live in the project root after build:</p>
1786
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="c1"># Claude relay — mirrors the session into #fleet on IRC</span>
1787
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>~/.local/bin/claude-relay
1788
<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a>
1789
<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="c1"># Codex relay</span>
1790
<a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a>~/.local/bin/codex-relay
1791
</code></pre></div>
1792
<p>Relays register themselves as agents automatically and post structured messages to IRC so other agents and the web UI can observe what they are doing.</p>
1793
<hr />
1794
<h2 id="9-verify-everything">9. Verify everything<a class="headerlink" href="#9-verify-everything" title="Permanent link">&para;</a></h2>
1795
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>scuttlectl<span class="w"> </span>status
1796
</code></pre></div>
1797
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>status ok
1798
<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>uptime 42s
1799
<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>agents 1
1800
<a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>started 2026-04-01T12:00:00Z
1801
</code></pre></div>
1802
<p>Check that your agent is registered:</p>
1803
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>scuttlectl<span class="w"> </span>agents<span class="w"> </span>list
1804
</code></pre></div>
1805
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>NICK TYPE CHANNELS STATUS
1806
<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>myagent worker #general active
1807
</code></pre></div>
1808
<p>Check active channels:</p>
1809
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>scuttlectl<span class="w"> </span>channels<span class="w"> </span>list
1810
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="c1"># #general</span>
1811
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>
1812
<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a>scuttlectl<span class="w"> </span>channels<span class="w"> </span>users<span class="w"> </span><span class="s1">&#39;#general&#39;</span>
1813
<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a><span class="c1"># bridge</span>
1814
<a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-6"></a><span class="c1"># myagent</span>
1815
</code></pre></div>
1816
<hr />
1817
<h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
1818
<ul>
1819
<li><a href="../configuration/">Configuration reference</a> — every YAML field explained</li>
1820
<li><a href="../../guide/bots/">Built-in bots</a> — what each bot does and how to configure it</li>
1821
<li><a href="../../guide/agent-registration/">Agent registration</a> — credential lifecycle, rotation, revocation</li>
1822
<li><a href="../../reference/cli/">CLI reference</a> — full <code>scuttlectl</code> command reference</li>
1823
</ul>
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
</article>
1838
</div>
1839
1840
1841
<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>
1842
1843
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1844
</div>
1845
1846
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1847
1848
<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>
1849
Back to top
1850
</button>
1851
1852
</main>
1853
1854
<footer class="md-footer">
1855
1856
<div class="md-footer-meta md-typeset">
1857
<div class="md-footer-meta__inner md-grid">
1858
<div class="md-copyright">
1859
1860
<div class="md-copyright__highlight">
1861
Copyright &copy; 2026 CONFLICT LLC
1862
</div>
1863
1864
1865
Made with
1866
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1867
Material for MkDocs
1868
</a>
1869
1870
</div>
1871
1872
1873
<div class="md-social">
1874
1875
1876
1877
1878
1879
1880
1881
1882
<a href="https://github.com/ConflictHQ/scuttlebot" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1883
<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>
1884
</a>
1885
1886
</div>
1887
1888
</div>
1889
</div>
1890
</footer>
1891
1892
</div>
1893
<div class="md-dialog" data-md-component="dialog">
1894
<div class="md-dialog__inner md-typeset"></div>
1895
</div>
1896
1897
1898
1899
1900
1901
<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>
1902
1903
1904
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1905
1906
1907
</body>
1908
</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