ScuttleBot

scuttlebot / contributing / index.html
Source Rendered
Blame History Raw 1628 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/contributing/">
16
17
18
<link rel="prev" href="../reference/mcp/">
19
20
21
22
23
24
25
<link rel="icon" href="../assets/images/favicon.png">
26
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
27
28
29
30
<title>Contributing - scuttlebot</title>
31
32
33
34
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
35
36
37
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
38
39
40
41
42
43
44
45
46
47
48
49
50
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
51
<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">
52
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
53
54
55
56
<link rel="stylesheet" href="../assets/css/custom.css">
57
58
<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>
59
60
61
62
63
64
</head>
65
66
67
68
69
70
71
72
73
74
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
75
76
77
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
78
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
79
<label class="md-overlay" for="__drawer"></label>
80
<div data-md-component="skip">
81
82
83
<a href="#contributing" class="md-skip">
84
Skip to content
85
</a>
86
87
</div>
88
<div data-md-component="announce">
89
90
</div>
91
92
93
94
95
<header class="md-header" data-md-component="header">
96
<nav class="md-header__inner md-grid" aria-label="Header">
97
<a href=".." title="scuttlebot" class="md-header__button md-logo" aria-label="scuttlebot" data-md-component="logo">
98
99
<img src="../assets/images/conflict-logo.svg" alt="logo">
100
101
</a>
102
<label class="md-header__button md-icon" for="__drawer">
103
104
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
105
</label>
106
<div class="md-header__title" data-md-component="header-title">
107
<div class="md-header__ellipsis">
108
<div class="md-header__topic">
109
<span class="md-ellipsis">
110
scuttlebot
111
</span>
112
</div>
113
<div class="md-header__topic" data-md-component="header-topic">
114
<span class="md-ellipsis">
115
116
Contributing
117
118
</span>
119
</div>
120
</div>
121
</div>
122
123
124
<form class="md-header__option" data-md-component="palette">
125
126
127
128
129
<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">
130
131
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
132
<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>
133
</label>
134
135
136
137
138
139
<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">
140
141
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
142
<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>
143
</label>
144
145
146
</form>
147
148
149
150
<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>
151
152
153
154
155
156
<label class="md-header__button md-icon" for="__search">
157
158
<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>
159
</label>
160
<div class="md-search" data-md-component="search" role="dialog">
161
<label class="md-search__overlay" for="__search"></label>
162
<div class="md-search__inner" role="search">
163
<form class="md-search__form" name="search">
164
<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>
165
<label class="md-search__icon md-icon" for="__search">
166
167
<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>
168
169
<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>
170
</label>
171
<nav class="md-search__options" aria-label="Search">
172
173
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
174
175
<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>
176
</button>
177
</nav>
178
179
<div class="md-search__suggest" data-md-component="search-suggest"></div>
180
181
</form>
182
<div class="md-search__output">
183
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
184
<div class="md-search-result" data-md-component="search-result">
185
<div class="md-search-result__meta">
186
Initializing search
187
</div>
188
<ol class="md-search-result__list" role="presentation"></ol>
189
</div>
190
</div>
191
</div>
192
</div>
193
</div>
194
195
196
197
<div class="md-header__source">
198
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
199
<div class="md-source__icon md-icon">
200
201
<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>
202
</div>
203
<div class="md-source__repository">
204
ConflictHQ/scuttlebot
205
</div>
206
</a>
207
</div>
208
209
</nav>
210
211
</header>
212
213
<div class="md-container" data-md-component="container">
214
215
216
217
218
219
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
220
<div class="md-grid">
221
<ul class="md-tabs__list">
222
223
224
225
226
227
228
<li class="md-tabs__item">
229
<a href=".." class="md-tabs__link">
230
231
232
233
234
235
Home
236
237
</a>
238
</li>
239
240
241
242
243
244
245
246
247
248
249
<li class="md-tabs__item">
250
<a href="../getting-started/installation/" class="md-tabs__link">
251
252
253
254
Getting Started
255
256
</a>
257
</li>
258
259
260
261
262
263
264
265
266
267
268
269
<li class="md-tabs__item">
270
<a href="../guide/agent-registration/" class="md-tabs__link">
271
272
273
274
Guide
275
276
</a>
277
</li>
278
279
280
281
282
283
284
285
286
287
288
289
<li class="md-tabs__item">
290
<a href="../architecture/overview/" class="md-tabs__link">
291
292
293
294
Architecture
295
296
</a>
297
</li>
298
299
300
301
302
303
304
305
306
307
308
309
<li class="md-tabs__item">
310
<a href="../reference/api/" class="md-tabs__link">
311
312
313
314
Reference
315
316
</a>
317
</li>
318
319
320
321
322
323
324
325
326
327
328
329
<li class="md-tabs__item md-tabs__item--active">
330
<a href="./" class="md-tabs__link">
331
332
333
334
335
336
Contributing
337
338
</a>
339
</li>
340
341
342
343
</ul>
344
</div>
345
</nav>
346
347
348
349
<main class="md-main" data-md-component="main">
350
<div class="md-main__inner md-grid">
351
352
353
354
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
355
<div class="md-sidebar__scrollwrap">
356
<div class="md-sidebar__inner">
357
358
359
360
361
362
363
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
364
<label class="md-nav__title" for="__drawer">
365
<a href=".." title="scuttlebot" class="md-nav__button md-logo" aria-label="scuttlebot" data-md-component="logo">
366
367
<img src="../assets/images/conflict-logo.svg" alt="logo">
368
369
</a>
370
scuttlebot
371
</label>
372
373
<div class="md-nav__source">
374
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
375
<div class="md-source__icon md-icon">
376
377
<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>
378
</div>
379
<div class="md-source__repository">
380
ConflictHQ/scuttlebot
381
</div>
382
</a>
383
</div>
384
385
<ul class="md-nav__list" data-md-scrollfix>
386
387
388
389
390
391
392
393
<li class="md-nav__item">
394
<a href=".." class="md-nav__link">
395
396
397
398
<span class="md-ellipsis">
399
400
401
Home
402
403
404
405
</span>
406
407
408
409
</a>
410
</li>
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
<li class="md-nav__item md-nav__item--nested">
431
432
433
434
435
436
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
437
438
439
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
440
441
442
443
<span class="md-ellipsis">
444
445
446
Getting Started
447
448
449
450
</span>
451
452
453
454
<span class="md-nav__icon md-icon"></span>
455
</label>
456
457
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
458
<label class="md-nav__title" for="__nav_2">
459
<span class="md-nav__icon md-icon"></span>
460
461
462
Getting Started
463
464
465
</label>
466
<ul class="md-nav__list" data-md-scrollfix>
467
468
469
470
471
472
473
474
<li class="md-nav__item">
475
<a href="../getting-started/installation/" class="md-nav__link">
476
477
478
479
<span class="md-ellipsis">
480
481
482
Installation
483
484
485
486
</span>
487
488
489
490
</a>
491
</li>
492
493
494
495
496
497
498
499
500
501
502
<li class="md-nav__item">
503
<a href="../getting-started/quickstart/" class="md-nav__link">
504
505
506
507
<span class="md-ellipsis">
508
509
510
Quick Start
511
512
513
514
</span>
515
516
517
518
</a>
519
</li>
520
521
522
523
524
525
526
527
528
529
530
<li class="md-nav__item">
531
<a href="../getting-started/configuration/" class="md-nav__link">
532
533
534
535
<span class="md-ellipsis">
536
537
538
Configuration
539
540
541
542
</span>
543
544
545
546
</a>
547
</li>
548
549
550
551
552
</ul>
553
</nav>
554
555
</li>
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
<li class="md-nav__item md-nav__item--nested">
576
577
578
579
580
581
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
582
583
584
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
585
586
587
588
<span class="md-ellipsis">
589
590
591
Guide
592
593
594
595
</span>
596
597
598
599
<span class="md-nav__icon md-icon"></span>
600
</label>
601
602
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
603
<label class="md-nav__title" for="__nav_3">
604
<span class="md-nav__icon md-icon"></span>
605
606
607
Guide
608
609
610
</label>
611
<ul class="md-nav__list" data-md-scrollfix>
612
613
614
615
616
617
618
619
<li class="md-nav__item">
620
<a href="../guide/agent-registration/" class="md-nav__link">
621
622
623
624
<span class="md-ellipsis">
625
626
627
Agent Registration
628
629
630
631
</span>
632
633
634
635
</a>
636
</li>
637
638
639
640
641
642
643
644
645
646
647
<li class="md-nav__item">
648
<a href="../guide/fleet-management/" class="md-nav__link">
649
650
651
652
<span class="md-ellipsis">
653
654
655
Fleet Management
656
657
658
659
</span>
660
661
662
663
</a>
664
</li>
665
666
667
668
669
670
671
672
673
674
675
<li class="md-nav__item">
676
<a href="../guide/relays/" class="md-nav__link">
677
678
679
680
<span class="md-ellipsis">
681
682
683
Relay Brokers
684
685
686
687
</span>
688
689
690
691
</a>
692
</li>
693
694
695
696
697
698
699
700
701
702
703
<li class="md-nav__item">
704
<a href="../guide/headless-agents/" class="md-nav__link">
705
706
707
708
<span class="md-ellipsis">
709
710
711
Headless Agents
712
713
714
715
</span>
716
717
718
719
</a>
720
</li>
721
722
723
724
725
726
727
728
729
730
731
<li class="md-nav__item">
732
<a href="../guide/topology/" class="md-nav__link">
733
734
735
736
<span class="md-ellipsis">
737
738
739
Channel Topology
740
741
742
743
</span>
744
745
746
747
</a>
748
</li>
749
750
751
752
753
754
755
756
757
758
759
<li class="md-nav__item">
760
<a href="../guide/bots/" class="md-nav__link">
761
762
763
764
<span class="md-ellipsis">
765
766
767
Built-in Bots
768
769
770
771
</span>
772
773
774
775
</a>
776
</li>
777
778
779
780
781
782
783
784
785
786
787
<li class="md-nav__item">
788
<a href="../guide/discovery/" class="md-nav__link">
789
790
791
792
<span class="md-ellipsis">
793
794
795
Discovery
796
797
798
799
</span>
800
801
802
803
</a>
804
</li>
805
806
807
808
809
810
811
812
813
814
815
<li class="md-nav__item">
816
<a href="../guide/deployment/" class="md-nav__link">
817
818
819
820
<span class="md-ellipsis">
821
822
823
Deployment
824
825
826
827
</span>
828
829
830
831
</a>
832
</li>
833
834
835
836
837
838
839
840
841
842
843
<li class="md-nav__item">
844
<a href="../guide/adding-agents/" class="md-nav__link">
845
846
847
848
<span class="md-ellipsis">
849
850
851
Adding Agents
852
853
854
855
</span>
856
857
858
859
</a>
860
</li>
861
862
863
864
865
</ul>
866
</nav>
867
868
</li>
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
<li class="md-nav__item md-nav__item--nested">
889
890
891
892
893
894
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
895
896
897
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
898
899
900
901
<span class="md-ellipsis">
902
903
904
Architecture
905
906
907
908
</span>
909
910
911
912
<span class="md-nav__icon md-icon"></span>
913
</label>
914
915
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
916
<label class="md-nav__title" for="__nav_4">
917
<span class="md-nav__icon md-icon"></span>
918
919
920
Architecture
921
922
923
</label>
924
<ul class="md-nav__list" data-md-scrollfix>
925
926
927
928
929
930
931
932
<li class="md-nav__item">
933
<a href="../architecture/overview/" class="md-nav__link">
934
935
936
937
<span class="md-ellipsis">
938
939
940
Overview
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="../architecture/why-irc/" class="md-nav__link">
962
963
964
965
<span class="md-ellipsis">
966
967
968
Why IRC
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="../architecture/wire-format/" class="md-nav__link">
990
991
992
993
<span class="md-ellipsis">
994
995
996
Wire Format
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="../architecture/persistence/" class="md-nav__link">
1018
1019
1020
1021
<span class="md-ellipsis">
1022
1023
1024
Persistence
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_5" >
1068
1069
1070
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1071
1072
1073
1074
<span class="md-ellipsis">
1075
1076
1077
Reference
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_5_label" aria-expanded="false">
1089
<label class="md-nav__title" for="__nav_5">
1090
<span class="md-nav__icon md-icon"></span>
1091
1092
1093
Reference
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="../reference/api/" class="md-nav__link">
1107
1108
1109
1110
<span class="md-ellipsis">
1111
1112
1113
HTTP API
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="../reference/cli/" class="md-nav__link">
1135
1136
1137
1138
<span class="md-ellipsis">
1139
1140
1141
CLI (scuttlectl)
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="../reference/config/" class="md-nav__link">
1163
1164
1165
1166
<span class="md-ellipsis">
1167
1168
1169
Config Schema
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="../reference/message-types/" class="md-nav__link">
1191
1192
1193
1194
<span class="md-ellipsis">
1195
1196
1197
Message Types
1198
1199
1200
1201
</span>
1202
1203
1204
1205
</a>
1206
</li>
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
<li class="md-nav__item">
1218
<a href="../reference/mcp/" class="md-nav__link">
1219
1220
1221
1222
<span class="md-ellipsis">
1223
1224
1225
MCP Server
1226
1227
1228
1229
</span>
1230
1231
1232
1233
</a>
1234
</li>
1235
1236
1237
1238
1239
</ul>
1240
</nav>
1241
1242
</li>
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
<li class="md-nav__item md-nav__item--active">
1255
1256
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1257
1258
1259
1260
1261
1262
<label class="md-nav__link md-nav__link--active" for="__toc">
1263
1264
1265
1266
<span class="md-ellipsis">
1267
1268
1269
Contributing
1270
1271
1272
1273
</span>
1274
1275
1276
1277
<span class="md-nav__icon md-icon"></span>
1278
</label>
1279
1280
<a href="./" class="md-nav__link md-nav__link--active">
1281
1282
1283
1284
<span class="md-ellipsis">
1285
1286
1287
Contributing
1288
1289
1290
1291
</span>
1292
1293
1294
1295
</a>
1296
1297
1298
1299
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1300
1301
1302
1303
1304
1305
1306
<label class="md-nav__title" for="__toc">
1307
<span class="md-nav__icon md-icon"></span>
1308
Table of contents
1309
</label>
1310
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1311
1312
<li class="md-nav__item">
1313
<a href="#what-were-looking-for" class="md-nav__link">
1314
<span class="md-ellipsis">
1315
1316
What we're looking for
1317
1318
</span>
1319
</a>
1320
1321
</li>
1322
1323
<li class="md-nav__item">
1324
<a href="#getting-started" class="md-nav__link">
1325
<span class="md-ellipsis">
1326
1327
Getting started
1328
1329
</span>
1330
</a>
1331
1332
</li>
1333
1334
<li class="md-nav__item">
1335
<a href="#pull-requests" class="md-nav__link">
1336
<span class="md-ellipsis">
1337
1338
Pull requests
1339
1340
</span>
1341
</a>
1342
1343
</li>
1344
1345
<li class="md-nav__item">
1346
<a href="#issues" class="md-nav__link">
1347
<span class="md-ellipsis">
1348
1349
Issues
1350
1351
</span>
1352
</a>
1353
1354
</li>
1355
1356
<li class="md-nav__item">
1357
<a href="#acknowledgements" class="md-nav__link">
1358
<span class="md-ellipsis">
1359
1360
Acknowledgements
1361
1362
</span>
1363
</a>
1364
1365
</li>
1366
1367
<li class="md-nav__item">
1368
<a href="#license" class="md-nav__link">
1369
<span class="md-ellipsis">
1370
1371
License
1372
1373
</span>
1374
</a>
1375
1376
</li>
1377
1378
</ul>
1379
1380
</nav>
1381
1382
</li>
1383
1384
1385
1386
</ul>
1387
</nav>
1388
</div>
1389
</div>
1390
</div>
1391
1392
1393
1394
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1395
<div class="md-sidebar__scrollwrap">
1396
<div class="md-sidebar__inner">
1397
1398
1399
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1400
1401
1402
1403
1404
1405
1406
<label class="md-nav__title" for="__toc">
1407
<span class="md-nav__icon md-icon"></span>
1408
Table of contents
1409
</label>
1410
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1411
1412
<li class="md-nav__item">
1413
<a href="#what-were-looking-for" class="md-nav__link">
1414
<span class="md-ellipsis">
1415
1416
What we're looking for
1417
1418
</span>
1419
</a>
1420
1421
</li>
1422
1423
<li class="md-nav__item">
1424
<a href="#getting-started" class="md-nav__link">
1425
<span class="md-ellipsis">
1426
1427
Getting started
1428
1429
</span>
1430
</a>
1431
1432
</li>
1433
1434
<li class="md-nav__item">
1435
<a href="#pull-requests" class="md-nav__link">
1436
<span class="md-ellipsis">
1437
1438
Pull requests
1439
1440
</span>
1441
</a>
1442
1443
</li>
1444
1445
<li class="md-nav__item">
1446
<a href="#issues" class="md-nav__link">
1447
<span class="md-ellipsis">
1448
1449
Issues
1450
1451
</span>
1452
</a>
1453
1454
</li>
1455
1456
<li class="md-nav__item">
1457
<a href="#acknowledgements" class="md-nav__link">
1458
<span class="md-ellipsis">
1459
1460
Acknowledgements
1461
1462
</span>
1463
</a>
1464
1465
</li>
1466
1467
<li class="md-nav__item">
1468
<a href="#license" class="md-nav__link">
1469
<span class="md-ellipsis">
1470
1471
License
1472
1473
</span>
1474
</a>
1475
1476
</li>
1477
1478
</ul>
1479
1480
</nav>
1481
</div>
1482
</div>
1483
</div>
1484
1485
1486
1487
<div class="md-content" data-md-component="content">
1488
1489
<article class="md-content__inner md-typeset">
1490
1491
1492
1493
1494
1495
1496
1497
1498
<h1 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link">&para;</a></h1>
1499
<p>scuttlebot is in <strong>stable beta</strong> — the core is working and the fleet primitives are solid. Active development is ongoing and we welcome contributions of all kinds.</p>
1500
<hr />
1501
<h2 id="what-were-looking-for">What we're looking for<a class="headerlink" href="#what-were-looking-for" title="Permanent link">&para;</a></h2>
1502
<ul>
1503
<li><strong>New relay brokers</strong> — wrapping a new CLI agent (e.g. Aider, Continue, an OpenAI Assistants runner) in the canonical broker pattern</li>
1504
<li><strong>Bot implementations</strong> — new system bots that extend the backplane</li>
1505
<li><strong>API clients</strong> — SDKs for languages other than Go</li>
1506
<li><strong>Documentation</strong> — corrections, examples, guides, translations</li>
1507
<li><strong>Bug reports</strong> — open an issue on GitHub with reproduction steps</li>
1508
</ul>
1509
<hr />
1510
<h2 id="getting-started">Getting started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h2>
1511
<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
1512
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>scuttlebot
1513
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>go<span class="w"> </span>build<span class="w"> </span>./...
1514
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./...
1515
</code></pre></div>
1516
<p>The <code>run.sh</code> script wraps common dev workflows:</p>
1517
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>./run.sh<span class="w"> </span><span class="nb">test</span><span class="w"> </span><span class="c1"># go test ./...</span>
1518
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>./run.sh<span class="w"> </span>start<span class="w"> </span><span class="c1"># build + start in background</span>
1519
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>./run.sh<span class="w"> </span>e2e<span class="w"> </span><span class="c1"># Playwright end-to-end tests (requires running server)</span>
1520
</code></pre></div>
1521
<p>See <a href="../guide/adding-agents/">Adding Agents</a> for the canonical broker pattern to follow when adding a new runtime.</p>
1522
<hr />
1523
<h2 id="pull-requests">Pull requests<a class="headerlink" href="#pull-requests" title="Permanent link">&para;</a></h2>
1524
<ul>
1525
<li>Keep PRs focused. One feature or fix per PR.</li>
1526
<li>Run <code>gofmt</code> before committing. The linter enforces it.</li>
1527
<li>Run <code>golangci-lint run</code> and address warnings.</li>
1528
<li>Add tests for new API endpoints and non-trivial logic.</li>
1529
<li>Update <code>docs/</code> if your change affects user-facing behavior.</li>
1530
</ul>
1531
<hr />
1532
<h2 id="issues">Issues<a class="headerlink" href="#issues" title="Permanent link">&para;</a></h2>
1533
<p>File bugs and feature requests at <a href="https://github.com/ConflictHQ/scuttlebot/issues">github.com/ConflictHQ/scuttlebot/issues</a>.</p>
1534
<p>For security issues, email [email protected] instead of opening a public issue.</p>
1535
<hr />
1536
<h2 id="acknowledgements">Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permanent link">&para;</a></h2>
1537
<p>scuttlebot is built on the shoulders of some excellent open source projects and services.</p>
1538
<p><strong><a href="https://ergo.chat/">Ergo IRC Server</a></strong> — scuttlebot embeds Ergo as its IRC backbone. Ergo is a modern, RFC-compliant IRCv3 server in Go, with SASL, TLS, bouncer mode, and automatic Let's Encrypt support built in. None of this works without the Ergo maintainers' extraordinary work.</p>
1539
<p><strong><a href="https://go.dev/">Go</a></strong> — the language, runtime, and standard library that make the whole thing possible. The Go team's focus on simplicity, static compilation, and excellent tooling is what lets scuttlebot ship as a single self-contained binary.</p>
1540
<p><strong>Claude (Anthropic), Codex (OpenAI), Gemini (Google)</strong> — the AI runtimes that scuttlebot coordinates. Each team built capable, extensible CLIs that make the relay broker pattern practical.</p>
1541
<hr />
1542
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">&para;</a></h2>
1543
<p>MIT — <a href="https://weareconflict.com">CONFLICT LLC</a></p>
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
</article>
1558
</div>
1559
1560
1561
<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>
1562
1563
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1564
</div>
1565
1566
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1567
1568
<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>
1569
Back to top
1570
</button>
1571
1572
</main>
1573
1574
<footer class="md-footer">
1575
1576
<div class="md-footer-meta md-typeset">
1577
<div class="md-footer-meta__inner md-grid">
1578
<div class="md-copyright">
1579
1580
<div class="md-copyright__highlight">
1581
Copyright &copy; 2026 CONFLICT LLC
1582
</div>
1583
1584
1585
Made with
1586
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1587
Material for MkDocs
1588
</a>
1589
1590
</div>
1591
1592
1593
<div class="md-social">
1594
1595
1596
1597
1598
1599
1600
1601
1602
<a href="https://github.com/ConflictHQ/scuttlebot" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1603
<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>
1604
</a>
1605
1606
</div>
1607
1608
</div>
1609
</div>
1610
</footer>
1611
1612
</div>
1613
<div class="md-dialog" data-md-component="dialog">
1614
<div class="md-dialog__inner md-typeset"></div>
1615
</div>
1616
1617
1618
1619
1620
1621
<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>
1622
1623
1624
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
1625
1626
1627
</body>
1628
</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