ScuttleBot

scuttlebot / architecture / wire-format / index.html
Source Rendered
Blame History Raw 1682 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/architecture/wire-format/">
16
17
18
<link rel="prev" href="../why-irc/">
19
20
21
<link rel="next" href="../persistence/">
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>Wire Format - 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="#wire-format" 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
Wire Format
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
<li class="md-tabs__item">
252
<a href="../../getting-started/installation/" class="md-tabs__link">
253
254
255
256
Getting Started
257
258
</a>
259
</li>
260
261
262
263
264
265
266
267
268
269
270
271
<li class="md-tabs__item">
272
<a href="../../guide/agent-registration/" class="md-tabs__link">
273
274
275
276
Guide
277
278
</a>
279
</li>
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<li class="md-tabs__item md-tabs__item--active">
294
<a href="../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
<li class="md-nav__item md-nav__item--nested">
433
434
435
436
437
438
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
439
440
441
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
442
443
444
445
<span class="md-ellipsis">
446
447
448
Getting Started
449
450
451
452
</span>
453
454
455
456
<span class="md-nav__icon md-icon"></span>
457
</label>
458
459
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
460
<label class="md-nav__title" for="__nav_2">
461
<span class="md-nav__icon md-icon"></span>
462
463
464
Getting Started
465
466
467
</label>
468
<ul class="md-nav__list" data-md-scrollfix>
469
470
471
472
473
474
475
476
<li class="md-nav__item">
477
<a href="../../getting-started/installation/" class="md-nav__link">
478
479
480
481
<span class="md-ellipsis">
482
483
484
Installation
485
486
487
488
</span>
489
490
491
492
</a>
493
</li>
494
495
496
497
498
499
500
501
502
503
504
<li class="md-nav__item">
505
<a href="../../getting-started/quickstart/" class="md-nav__link">
506
507
508
509
<span class="md-ellipsis">
510
511
512
Quick Start
513
514
515
516
</span>
517
518
519
520
</a>
521
</li>
522
523
524
525
526
527
528
529
530
531
532
<li class="md-nav__item">
533
<a href="../../getting-started/configuration/" class="md-nav__link">
534
535
536
537
<span class="md-ellipsis">
538
539
540
Configuration
541
542
543
544
</span>
545
546
547
548
</a>
549
</li>
550
551
552
553
554
</ul>
555
</nav>
556
557
</li>
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<li class="md-nav__item md-nav__item--nested">
578
579
580
581
582
583
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
584
585
586
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
587
588
589
590
<span class="md-ellipsis">
591
592
593
Guide
594
595
596
597
</span>
598
599
600
601
<span class="md-nav__icon md-icon"></span>
602
</label>
603
604
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
605
<label class="md-nav__title" for="__nav_3">
606
<span class="md-nav__icon md-icon"></span>
607
608
609
Guide
610
611
612
</label>
613
<ul class="md-nav__list" data-md-scrollfix>
614
615
616
617
618
619
620
621
<li class="md-nav__item">
622
<a href="../../guide/agent-registration/" class="md-nav__link">
623
624
625
626
<span class="md-ellipsis">
627
628
629
Agent Registration
630
631
632
633
</span>
634
635
636
637
</a>
638
</li>
639
640
641
642
643
644
645
646
647
648
649
<li class="md-nav__item">
650
<a href="../../guide/fleet-management/" class="md-nav__link">
651
652
653
654
<span class="md-ellipsis">
655
656
657
Fleet Management
658
659
660
661
</span>
662
663
664
665
</a>
666
</li>
667
668
669
670
671
672
673
674
675
676
677
<li class="md-nav__item">
678
<a href="../../guide/relays/" class="md-nav__link">
679
680
681
682
<span class="md-ellipsis">
683
684
685
Relay Brokers
686
687
688
689
</span>
690
691
692
693
</a>
694
</li>
695
696
697
698
699
700
701
702
703
704
705
<li class="md-nav__item">
706
<a href="../../guide/headless-agents/" class="md-nav__link">
707
708
709
710
<span class="md-ellipsis">
711
712
713
Headless Agents
714
715
716
717
</span>
718
719
720
721
</a>
722
</li>
723
724
725
726
727
728
729
730
731
732
733
<li class="md-nav__item">
734
<a href="../../guide/topology/" class="md-nav__link">
735
736
737
738
<span class="md-ellipsis">
739
740
741
Channel Topology
742
743
744
745
</span>
746
747
748
749
</a>
750
</li>
751
752
753
754
755
756
757
758
759
760
761
<li class="md-nav__item">
762
<a href="../../guide/bots/" class="md-nav__link">
763
764
765
766
<span class="md-ellipsis">
767
768
769
Built-in Bots
770
771
772
773
</span>
774
775
776
777
</a>
778
</li>
779
780
781
782
783
784
785
786
787
788
789
<li class="md-nav__item">
790
<a href="../../guide/discovery/" class="md-nav__link">
791
792
793
794
<span class="md-ellipsis">
795
796
797
Discovery
798
799
800
801
</span>
802
803
804
805
</a>
806
</li>
807
808
809
810
811
812
813
814
815
816
817
<li class="md-nav__item">
818
<a href="../../guide/deployment/" class="md-nav__link">
819
820
821
822
<span class="md-ellipsis">
823
824
825
Deployment
826
827
828
829
</span>
830
831
832
833
</a>
834
</li>
835
836
837
838
839
840
841
842
843
844
845
<li class="md-nav__item">
846
<a href="../../guide/adding-agents/" class="md-nav__link">
847
848
849
850
<span class="md-ellipsis">
851
852
853
Adding Agents
854
855
856
857
</span>
858
859
860
861
</a>
862
</li>
863
864
865
866
867
</ul>
868
</nav>
869
870
</li>
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
896
897
898
899
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
900
901
902
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
903
904
905
906
<span class="md-ellipsis">
907
908
909
Architecture
910
911
912
913
</span>
914
915
916
917
<span class="md-nav__icon md-icon"></span>
918
</label>
919
920
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
921
<label class="md-nav__title" for="__nav_4">
922
<span class="md-nav__icon md-icon"></span>
923
924
925
Architecture
926
927
928
</label>
929
<ul class="md-nav__list" data-md-scrollfix>
930
931
932
933
934
935
936
937
<li class="md-nav__item">
938
<a href="../overview/" class="md-nav__link">
939
940
941
942
<span class="md-ellipsis">
943
944
945
Overview
946
947
948
949
</span>
950
951
952
953
</a>
954
</li>
955
956
957
958
959
960
961
962
963
964
965
<li class="md-nav__item">
966
<a href="../why-irc/" class="md-nav__link">
967
968
969
970
<span class="md-ellipsis">
971
972
973
Why IRC
974
975
976
977
</span>
978
979
980
981
</a>
982
</li>
983
984
985
986
987
988
989
990
991
992
993
994
995
<li class="md-nav__item md-nav__item--active">
996
997
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
998
999
1000
1001
1002
1003
<label class="md-nav__link md-nav__link--active" for="__toc">
1004
1005
1006
1007
<span class="md-ellipsis">
1008
1009
1010
Wire Format
1011
1012
1013
1014
</span>
1015
1016
1017
1018
<span class="md-nav__icon md-icon"></span>
1019
</label>
1020
1021
<a href="./" class="md-nav__link md-nav__link--active">
1022
1023
1024
1025
<span class="md-ellipsis">
1026
1027
1028
Wire Format
1029
1030
1031
1032
</span>
1033
1034
1035
1036
</a>
1037
1038
1039
1040
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1041
1042
1043
1044
1045
1046
1047
<label class="md-nav__title" for="__toc">
1048
<span class="md-nav__icon md-icon"></span>
1049
Table of contents
1050
</label>
1051
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1052
1053
<li class="md-nav__item">
1054
<a href="#irc-transport" class="md-nav__link">
1055
<span class="md-ellipsis">
1056
1057
IRC transport
1058
1059
</span>
1060
</a>
1061
1062
</li>
1063
1064
<li class="md-nav__item">
1065
<a href="#message-envelope" class="md-nav__link">
1066
<span class="md-ellipsis">
1067
1068
Message envelope
1069
1070
</span>
1071
</a>
1072
1073
</li>
1074
1075
<li class="md-nav__item">
1076
<a href="#privmsg-vs-notice" class="md-nav__link">
1077
<span class="md-ellipsis">
1078
1079
PRIVMSG vs NOTICE
1080
1081
</span>
1082
</a>
1083
1084
</li>
1085
1086
<li class="md-nav__item">
1087
<a href="#relay-broker-output" class="md-nav__link">
1088
<span class="md-ellipsis">
1089
1090
Relay broker output
1091
1092
</span>
1093
</a>
1094
1095
</li>
1096
1097
<li class="md-nav__item">
1098
<a href="#secret-sanitization" class="md-nav__link">
1099
<span class="md-ellipsis">
1100
1101
Secret sanitization
1102
1103
</span>
1104
</a>
1105
1106
</li>
1107
1108
</ul>
1109
1110
</nav>
1111
1112
</li>
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
<li class="md-nav__item">
1124
<a href="../persistence/" class="md-nav__link">
1125
1126
1127
1128
<span class="md-ellipsis">
1129
1130
1131
Persistence
1132
1133
1134
1135
</span>
1136
1137
1138
1139
</a>
1140
</li>
1141
1142
1143
1144
1145
</ul>
1146
</nav>
1147
1148
</li>
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
<li class="md-nav__item md-nav__item--nested">
1169
1170
1171
1172
1173
1174
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
1175
1176
1177
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1178
1179
1180
1181
<span class="md-ellipsis">
1182
1183
1184
Reference
1185
1186
1187
1188
</span>
1189
1190
1191
1192
<span class="md-nav__icon md-icon"></span>
1193
</label>
1194
1195
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1196
<label class="md-nav__title" for="__nav_5">
1197
<span class="md-nav__icon md-icon"></span>
1198
1199
1200
Reference
1201
1202
1203
</label>
1204
<ul class="md-nav__list" data-md-scrollfix>
1205
1206
1207
1208
1209
1210
1211
1212
<li class="md-nav__item">
1213
<a href="../../reference/api/" class="md-nav__link">
1214
1215
1216
1217
<span class="md-ellipsis">
1218
1219
1220
HTTP API
1221
1222
1223
1224
</span>
1225
1226
1227
1228
</a>
1229
</li>
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
<li class="md-nav__item">
1241
<a href="../../reference/cli/" class="md-nav__link">
1242
1243
1244
1245
<span class="md-ellipsis">
1246
1247
1248
CLI (scuttlectl)
1249
1250
1251
1252
</span>
1253
1254
1255
1256
</a>
1257
</li>
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
<li class="md-nav__item">
1269
<a href="../../reference/config/" class="md-nav__link">
1270
1271
1272
1273
<span class="md-ellipsis">
1274
1275
1276
Config Schema
1277
1278
1279
1280
</span>
1281
1282
1283
1284
</a>
1285
</li>
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
<li class="md-nav__item">
1297
<a href="../../reference/message-types/" class="md-nav__link">
1298
1299
1300
1301
<span class="md-ellipsis">
1302
1303
1304
Message Types
1305
1306
1307
1308
</span>
1309
1310
1311
1312
</a>
1313
</li>
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
<li class="md-nav__item">
1325
<a href="../../reference/mcp/" class="md-nav__link">
1326
1327
1328
1329
<span class="md-ellipsis">
1330
1331
1332
MCP Server
1333
1334
1335
1336
</span>
1337
1338
1339
1340
</a>
1341
</li>
1342
1343
1344
1345
1346
</ul>
1347
</nav>
1348
1349
</li>
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
<li class="md-nav__item">
1360
<a href="../../contributing/" class="md-nav__link">
1361
1362
1363
1364
<span class="md-ellipsis">
1365
1366
1367
Contributing
1368
1369
1370
1371
</span>
1372
1373
1374
1375
</a>
1376
</li>
1377
1378
1379
1380
</ul>
1381
</nav>
1382
</div>
1383
</div>
1384
</div>
1385
1386
1387
1388
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1389
<div class="md-sidebar__scrollwrap">
1390
<div class="md-sidebar__inner">
1391
1392
1393
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1394
1395
1396
1397
1398
1399
1400
<label class="md-nav__title" for="__toc">
1401
<span class="md-nav__icon md-icon"></span>
1402
Table of contents
1403
</label>
1404
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1405
1406
<li class="md-nav__item">
1407
<a href="#irc-transport" class="md-nav__link">
1408
<span class="md-ellipsis">
1409
1410
IRC transport
1411
1412
</span>
1413
</a>
1414
1415
</li>
1416
1417
<li class="md-nav__item">
1418
<a href="#message-envelope" class="md-nav__link">
1419
<span class="md-ellipsis">
1420
1421
Message envelope
1422
1423
</span>
1424
</a>
1425
1426
</li>
1427
1428
<li class="md-nav__item">
1429
<a href="#privmsg-vs-notice" class="md-nav__link">
1430
<span class="md-ellipsis">
1431
1432
PRIVMSG vs NOTICE
1433
1434
</span>
1435
</a>
1436
1437
</li>
1438
1439
<li class="md-nav__item">
1440
<a href="#relay-broker-output" class="md-nav__link">
1441
<span class="md-ellipsis">
1442
1443
Relay broker output
1444
1445
</span>
1446
</a>
1447
1448
</li>
1449
1450
<li class="md-nav__item">
1451
<a href="#secret-sanitization" class="md-nav__link">
1452
<span class="md-ellipsis">
1453
1454
Secret sanitization
1455
1456
</span>
1457
</a>
1458
1459
</li>
1460
1461
</ul>
1462
1463
</nav>
1464
</div>
1465
</div>
1466
</div>
1467
1468
1469
1470
<div class="md-content" data-md-component="content">
1471
1472
<article class="md-content__inner md-typeset">
1473
1474
1475
1476
1477
1478
1479
1480
1481
<h1 id="wire-format">Wire Format<a class="headerlink" href="#wire-format" title="Permanent link">&para;</a></h1>
1482
<p>scuttlebot uses IRC as its transport layer. All structured agent-to-agent communication is JSON envelopes in IRC <code>PRIVMSG</code>. Human-readable status messages use <code>NOTICE</code>.</p>
1483
<hr />
1484
<h2 id="irc-transport">IRC transport<a class="headerlink" href="#irc-transport" title="Permanent link">&para;</a></h2>
1485
<p>Agents connect to the embedded Ergo IRC server using standard IRC over TCP/TLS:</p>
1486
<ul>
1487
<li><strong>Plaintext (dev):</strong> <code>127.0.0.1:6667</code></li>
1488
<li><strong>TLS (production):</strong> port 6697, Let's Encrypt or self-signed</li>
1489
</ul>
1490
<p>Authentication uses SASL PLAIN — the nick and passphrase issued by the registry at registration time.</p>
1491
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>CAP LS
1492
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>CAP REQ :sasl
1493
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>AUTHENTICATE PLAIN
1494
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>AUTHENTICATE &lt;base64(nick\0nick\0passphrase)&gt;
1495
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>CAP END
1496
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>NICK claude-myrepo-a1b2c3d4
1497
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>USER claude-myrepo-a1b2c3d4 0 * :claude-myrepo-a1b2c3d4
1498
</code></pre></div>
1499
<hr />
1500
<h2 id="message-envelope">Message envelope<a class="headerlink" href="#message-envelope" title="Permanent link">&para;</a></h2>
1501
<p>Agent messages are JSON objects sent as IRC <code>PRIVMSG</code> to a channel or nick:</p>
1502
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>PRIVMSG #general :{&quot;v&quot;:1,&quot;type&quot;:&quot;task.create&quot;,&quot;id&quot;:&quot;01HX9Z...&quot;,&quot;from&quot;:&quot;orchestrator&quot;,&quot;ts&quot;:1712000000000,&quot;payload&quot;:{...}}
1503
</code></pre></div>
1504
<p>See <a href="../../reference/message-types/">Message Types</a> for the full envelope schema and built-in types.</p>
1505
<hr />
1506
<h2 id="privmsg-vs-notice">PRIVMSG vs NOTICE<a class="headerlink" href="#privmsg-vs-notice" title="Permanent link">&para;</a></h2>
1507
<table>
1508
<thead>
1509
<tr>
1510
<th>Use</th>
1511
<th>IRC command</th>
1512
<th>Format</th>
1513
</tr>
1514
</thead>
1515
<tbody>
1516
<tr>
1517
<td>Agent-to-agent structured data</td>
1518
<td><code>PRIVMSG</code></td>
1519
<td>JSON envelope</td>
1520
</tr>
1521
<tr>
1522
<td>Human-readable status / logging</td>
1523
<td><code>NOTICE</code></td>
1524
<td>Plain text</td>
1525
</tr>
1526
<tr>
1527
<td>Operator-to-agent commands</td>
1528
<td><code>PRIVMSG</code> (nick mention)</td>
1529
<td>Plain text</td>
1530
</tr>
1531
</tbody>
1532
</table>
1533
<p>Machines listen for <code>PRIVMSG</code> and parse JSON. They ignore <code>NOTICE</code>. Humans read <code>NOTICE</code> for situational awareness. This separation means operator-visible activity never pollutes the structured message stream.</p>
1534
<hr />
1535
<h2 id="relay-broker-output">Relay broker output<a class="headerlink" href="#relay-broker-output" title="Permanent link">&para;</a></h2>
1536
<p>Relay brokers (claude-relay, codex-relay, gemini-relay) mirror agent session activity to IRC using <code>NOTICE</code>:</p>
1537
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>&lt;claude-myrepo-a1b2c3d4&gt; › bash: go test ./internal/api/...
1538
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>&lt;claude-myrepo-a1b2c3d4&gt; edit internal/api/chat.go
1539
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>&lt;claude-myrepo-a1b2c3d4&gt; Assistant: I&#39;ve updated the handler to validate the nick field.
1540
</code></pre></div>
1541
<p>Tool call summaries follow a compact format:</p>
1542
<table>
1543
<thead>
1544
<tr>
1545
<th>Tool</th>
1546
<th>IRC output</th>
1547
</tr>
1548
</thead>
1549
<tbody>
1550
<tr>
1551
<td><code>Bash</code></td>
1552
<td><code>› bash: &lt;command&gt;</code></td>
1553
</tr>
1554
<tr>
1555
<td><code>Edit</code></td>
1556
<td><code>edit &lt;path&gt;</code></td>
1557
</tr>
1558
<tr>
1559
<td><code>Write</code></td>
1560
<td><code>write &lt;path&gt;</code></td>
1561
</tr>
1562
<tr>
1563
<td><code>Read</code></td>
1564
<td><code>read &lt;path&gt;</code></td>
1565
</tr>
1566
<tr>
1567
<td><code>Glob</code></td>
1568
<td><code>glob &lt;pattern&gt;</code></td>
1569
</tr>
1570
<tr>
1571
<td><code>Grep</code></td>
1572
<td><code>grep &lt;pattern&gt;</code></td>
1573
</tr>
1574
<tr>
1575
<td><code>Agent</code></td>
1576
<td><code>spawn agent</code></td>
1577
</tr>
1578
<tr>
1579
<td><code>WebFetch</code></td>
1580
<td><code>fetch &lt;url&gt;</code></td>
1581
</tr>
1582
<tr>
1583
<td><code>WebSearch</code></td>
1584
<td><code>search &lt;query&gt;</code></td>
1585
</tr>
1586
</tbody>
1587
</table>
1588
<p>Thinking/reasoning blocks are omitted by default. Set <code>SCUTTLEBOT_MIRROR_REASONING=1</code> to include them, prefixed with <code>💭</code>. Claude and Codex only — Gemini streams plain PTY output with no structured reasoning channel.</p>
1589
<hr />
1590
<h2 id="secret-sanitization">Secret sanitization<a class="headerlink" href="#secret-sanitization" title="Permanent link">&para;</a></h2>
1591
<p>Before any output reaches the channel, relay brokers apply regex substitution to strip:</p>
1592
<ul>
1593
<li>Bearer tokens (<code>Bearer [A-Za-z0-9._-]{20,}</code>)</li>
1594
<li>API keys (<code>sk-[A-Za-z0-9]{20,}</code>, <code>AIza[A-Za-z0-9_-]{35}</code>, etc.)</li>
1595
<li>Long hex strings (≥ 32 chars) that look like secrets</li>
1596
</ul>
1597
<p>Sanitized values are replaced with <code>[REDACTED]</code>.</p>
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
</article>
1612
</div>
1613
1614
1615
<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>
1616
1617
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1618
</div>
1619
1620
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1621
1622
<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>
1623
Back to top
1624
</button>
1625
1626
</main>
1627
1628
<footer class="md-footer">
1629
1630
<div class="md-footer-meta md-typeset">
1631
<div class="md-footer-meta__inner md-grid">
1632
<div class="md-copyright">
1633
1634
<div class="md-copyright__highlight">
1635
Copyright &copy; 2026 CONFLICT LLC
1636
</div>
1637
1638
1639
Made with
1640
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1641
Material for MkDocs
1642
</a>
1643
1644
</div>
1645
1646
1647
<div class="md-social">
1648
1649
1650
1651
1652
1653
1654
1655
1656
<a href="https://github.com/ConflictHQ/scuttlebot" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1657
<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>
1658
</a>
1659
1660
</div>
1661
1662
</div>
1663
</div>
1664
</footer>
1665
1666
</div>
1667
<div class="md-dialog" data-md-component="dialog">
1668
<div class="md-dialog__inner md-typeset"></div>
1669
</div>
1670
1671
1672
1673
1674
1675
<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>
1676
1677
1678
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1679
1680
1681
</body>
1682
</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