BoilerWorks

boilerworks / index.html
Source Rendered
Blame History Raw 1386 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="The CLI for boilerworks.ai — stop vibe-coding scaffolding">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://boilerworks.dev/">
16
17
18
19
<link rel="next" href="getting-started/installation/">
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>Boilerworks</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="#boilerworks" 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="Boilerworks" class="md-header__button md-logo" aria-label="Boilerworks" data-md-component="logo">
98
99
<img src="assets/images/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
Boilerworks
111
</span>
112
</div>
113
<div class="md-header__topic" data-md-component="header-topic">
114
<span class="md-ellipsis">
115
116
Home
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/boilerworks" 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/boilerworks
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
229
230
<li class="md-tabs__item md-tabs__item--active">
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/templates/" class="md-tabs__link">
273
274
275
276
Templates
277
278
</a>
279
</li>
280
281
282
283
284
285
286
287
288
289
290
291
<li class="md-tabs__item">
292
<a href="cli/setup/" class="md-tabs__link">
293
294
295
296
CLI Reference
297
298
</a>
299
</li>
300
301
302
303
304
305
306
307
308
309
<li class="md-tabs__item">
310
<a href="contributing/" class="md-tabs__link">
311
312
313
314
315
316
Contributing
317
318
</a>
319
</li>
320
321
322
323
</ul>
324
</div>
325
</nav>
326
327
328
329
<main class="md-main" data-md-component="main">
330
<div class="md-main__inner md-grid">
331
332
333
334
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
335
<div class="md-sidebar__scrollwrap">
336
<div class="md-sidebar__inner">
337
338
339
340
341
342
343
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
344
<label class="md-nav__title" for="__drawer">
345
<a href="." title="Boilerworks" class="md-nav__button md-logo" aria-label="Boilerworks" data-md-component="logo">
346
347
<img src="assets/images/logo.svg" alt="logo">
348
349
</a>
350
Boilerworks
351
</label>
352
353
<div class="md-nav__source">
354
<a href="https://github.com/ConflictHQ/boilerworks" title="Go to repository" class="md-source" data-md-component="source">
355
<div class="md-source__icon md-icon">
356
357
<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>
358
</div>
359
<div class="md-source__repository">
360
ConflictHQ/boilerworks
361
</div>
362
</a>
363
</div>
364
365
<ul class="md-nav__list" data-md-scrollfix>
366
367
368
369
370
371
372
373
374
375
<li class="md-nav__item md-nav__item--active">
376
377
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
378
379
380
381
382
383
<label class="md-nav__link md-nav__link--active" for="__toc">
384
385
386
387
<span class="md-ellipsis">
388
389
390
Home
391
392
393
394
</span>
395
396
397
398
<span class="md-nav__icon md-icon"></span>
399
</label>
400
401
<a href="." class="md-nav__link md-nav__link--active">
402
403
404
405
<span class="md-ellipsis">
406
407
408
Home
409
410
411
412
</span>
413
414
415
416
</a>
417
418
419
420
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
421
422
423
424
425
426
427
<label class="md-nav__title" for="__toc">
428
<span class="md-nav__icon md-icon"></span>
429
Table of contents
430
</label>
431
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
432
433
<li class="md-nav__item">
434
<a href="#install" class="md-nav__link">
435
<span class="md-ellipsis">
436
437
Install
438
439
</span>
440
</a>
441
442
</li>
443
444
<li class="md-nav__item">
445
<a href="#quick-start" class="md-nav__link">
446
<span class="md-ellipsis">
447
448
Quick Start
449
450
</span>
451
</a>
452
453
</li>
454
455
<li class="md-nav__item">
456
<a href="#the-catalogue" class="md-nav__link">
457
<span class="md-ellipsis">
458
459
The Catalogue
460
461
</span>
462
</a>
463
464
</li>
465
466
<li class="md-nav__item">
467
<a href="#how-it-works" class="md-nav__link">
468
<span class="md-ellipsis">
469
470
How It Works
471
472
</span>
473
</a>
474
475
</li>
476
477
<li class="md-nav__item">
478
<a href="#infrastructure-optional" class="md-nav__link">
479
<span class="md-ellipsis">
480
481
Infrastructure (optional)
482
483
</span>
484
</a>
485
486
</li>
487
488
<li class="md-nav__item">
489
<a href="#license" class="md-nav__link">
490
<span class="md-ellipsis">
491
492
License
493
494
</span>
495
</a>
496
497
</li>
498
499
</ul>
500
501
</nav>
502
503
</li>
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
<li class="md-nav__item md-nav__item--nested">
524
525
526
527
528
529
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
530
531
532
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
533
534
535
536
<span class="md-ellipsis">
537
538
539
Getting Started
540
541
542
543
</span>
544
545
546
547
<span class="md-nav__icon md-icon"></span>
548
</label>
549
550
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
551
<label class="md-nav__title" for="__nav_2">
552
<span class="md-nav__icon md-icon"></span>
553
554
555
Getting Started
556
557
558
</label>
559
<ul class="md-nav__list" data-md-scrollfix>
560
561
562
563
564
565
566
567
<li class="md-nav__item">
568
<a href="getting-started/installation/" class="md-nav__link">
569
570
571
572
<span class="md-ellipsis">
573
574
575
Installation
576
577
578
579
</span>
580
581
582
583
</a>
584
</li>
585
586
587
588
589
590
591
592
593
594
595
<li class="md-nav__item">
596
<a href="getting-started/quickstart/" class="md-nav__link">
597
598
599
600
<span class="md-ellipsis">
601
602
603
Quick Start
604
605
606
607
</span>
608
609
610
611
</a>
612
</li>
613
614
615
616
617
618
619
620
621
622
623
<li class="md-nav__item">
624
<a href="getting-started/configuration/" class="md-nav__link">
625
626
627
628
<span class="md-ellipsis">
629
630
631
Configuration
632
633
634
635
</span>
636
637
638
639
</a>
640
</li>
641
642
643
644
645
</ul>
646
</nav>
647
648
</li>
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
<li class="md-nav__item md-nav__item--nested">
669
670
671
672
673
674
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
675
676
677
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
678
679
680
681
<span class="md-ellipsis">
682
683
684
Templates
685
686
687
688
</span>
689
690
691
692
<span class="md-nav__icon md-icon"></span>
693
</label>
694
695
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
696
<label class="md-nav__title" for="__nav_3">
697
<span class="md-nav__icon md-icon"></span>
698
699
700
Templates
701
702
703
</label>
704
<ul class="md-nav__list" data-md-scrollfix>
705
706
707
708
709
710
711
712
<li class="md-nav__item">
713
<a href="guide/templates/" class="md-nav__link">
714
715
716
717
<span class="md-ellipsis">
718
719
720
Catalogue
721
722
723
724
</span>
725
726
727
728
</a>
729
</li>
730
731
732
733
734
735
736
737
738
739
740
<li class="md-nav__item">
741
<a href="guide/choosing/" class="md-nav__link">
742
743
744
745
<span class="md-ellipsis">
746
747
748
Choosing a Template
749
750
751
752
</span>
753
754
755
756
</a>
757
</li>
758
759
760
761
762
</ul>
763
</nav>
764
765
</li>
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
<li class="md-nav__item md-nav__item--nested">
786
787
788
789
790
791
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
792
793
794
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
795
796
797
798
<span class="md-ellipsis">
799
800
801
CLI Reference
802
803
804
805
</span>
806
807
808
809
<span class="md-nav__icon md-icon"></span>
810
</label>
811
812
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
813
<label class="md-nav__title" for="__nav_4">
814
<span class="md-nav__icon md-icon"></span>
815
816
817
CLI Reference
818
819
820
</label>
821
<ul class="md-nav__list" data-md-scrollfix>
822
823
824
825
826
827
828
829
<li class="md-nav__item">
830
<a href="cli/setup/" class="md-nav__link">
831
832
833
834
<span class="md-ellipsis">
835
836
837
setup
838
839
840
841
</span>
842
843
844
845
</a>
846
</li>
847
848
849
850
851
852
853
854
855
856
857
<li class="md-nav__item">
858
<a href="cli/init/" class="md-nav__link">
859
860
861
862
<span class="md-ellipsis">
863
864
865
init
866
867
868
869
</span>
870
871
872
873
</a>
874
</li>
875
876
877
878
879
880
881
882
883
884
885
<li class="md-nav__item">
886
<a href="cli/list/" class="md-nav__link">
887
888
889
890
<span class="md-ellipsis">
891
892
893
list
894
895
896
897
</span>
898
899
900
901
</a>
902
</li>
903
904
905
906
907
908
909
910
911
912
913
<li class="md-nav__item">
914
<a href="cli/bootstrap/" class="md-nav__link">
915
916
917
918
<span class="md-ellipsis">
919
920
921
bootstrap
922
923
924
925
</span>
926
927
928
929
</a>
930
</li>
931
932
933
934
935
</ul>
936
</nav>
937
938
</li>
939
940
941
942
943
944
945
946
947
948
<li class="md-nav__item">
949
<a href="contributing/" class="md-nav__link">
950
951
952
953
<span class="md-ellipsis">
954
955
956
Contributing
957
958
959
960
</span>
961
962
963
964
</a>
965
</li>
966
967
968
969
</ul>
970
</nav>
971
</div>
972
</div>
973
</div>
974
975
976
977
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
978
<div class="md-sidebar__scrollwrap">
979
<div class="md-sidebar__inner">
980
981
982
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
983
984
985
986
987
988
989
<label class="md-nav__title" for="__toc">
990
<span class="md-nav__icon md-icon"></span>
991
Table of contents
992
</label>
993
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
994
995
<li class="md-nav__item">
996
<a href="#install" class="md-nav__link">
997
<span class="md-ellipsis">
998
999
Install
1000
1001
</span>
1002
</a>
1003
1004
</li>
1005
1006
<li class="md-nav__item">
1007
<a href="#quick-start" class="md-nav__link">
1008
<span class="md-ellipsis">
1009
1010
Quick Start
1011
1012
</span>
1013
</a>
1014
1015
</li>
1016
1017
<li class="md-nav__item">
1018
<a href="#the-catalogue" class="md-nav__link">
1019
<span class="md-ellipsis">
1020
1021
The Catalogue
1022
1023
</span>
1024
</a>
1025
1026
</li>
1027
1028
<li class="md-nav__item">
1029
<a href="#how-it-works" class="md-nav__link">
1030
<span class="md-ellipsis">
1031
1032
How It Works
1033
1034
</span>
1035
</a>
1036
1037
</li>
1038
1039
<li class="md-nav__item">
1040
<a href="#infrastructure-optional" class="md-nav__link">
1041
<span class="md-ellipsis">
1042
1043
Infrastructure (optional)
1044
1045
</span>
1046
</a>
1047
1048
</li>
1049
1050
<li class="md-nav__item">
1051
<a href="#license" class="md-nav__link">
1052
<span class="md-ellipsis">
1053
1054
License
1055
1056
</span>
1057
</a>
1058
1059
</li>
1060
1061
</ul>
1062
1063
</nav>
1064
</div>
1065
</div>
1066
</div>
1067
1068
1069
1070
<div class="md-content" data-md-component="content">
1071
1072
<article class="md-content__inner md-typeset">
1073
1074
1075
1076
1077
1078
1079
1080
1081
<h1 id="boilerworks">Boilerworks<a class="headerlink" href="#boilerworks" title="Permanent link">&para;</a></h1>
1082
<p><strong>Stop vibe-coding scaffolding. Pick a template. Ship.</strong></p>
1083
<p>Boilerworks is a catalogue of opinionated, production-ready full-stack templates. One command gets you from zero to a running app with auth, database, background jobs, Docker, and CI — all pre-wired.</p>
1084
<hr />
1085
<h2 id="install">Install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h2>
1086
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>boilerworks
1087
</code></pre></div>
1088
<h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h2>
1089
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># See all templates</span>
1090
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>boilerworks<span class="w"> </span>list
1091
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
1092
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1"># Run the setup wizard</span>
1093
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>boilerworks<span class="w"> </span>setup
1094
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>
1095
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="c1"># Generate your project</span>
1096
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>boilerworks<span class="w"> </span>init
1097
</code></pre></div>
1098
<p>That's it. <code>boilerworks init</code> clones the template, renames everything from <code>boilerworks</code> to your project name, and hands you a working repo with a clean git history.</p>
1099
<hr />
1100
<h2 id="the-catalogue">The Catalogue<a class="headerlink" href="#the-catalogue" title="Permanent link">&para;</a></h2>
1101
<p>26 templates across 10 stacks. Three sizes.</p>
1102
<table>
1103
<thead>
1104
<tr>
1105
<th>Size</th>
1106
<th>When to use</th>
1107
</tr>
1108
</thead>
1109
<tbody>
1110
<tr>
1111
<td><strong>Full</strong></td>
1112
<td>Apps with users — login, permissions, org management</td>
1113
</tr>
1114
<tr>
1115
<td><strong>Micro</strong></td>
1116
<td>API-key services, microservices, workers</td>
1117
</tr>
1118
<tr>
1119
<td><strong>Edge</strong></td>
1120
<td>Cloudflare Workers / Pages, globally distributed</td>
1121
</tr>
1122
</tbody>
1123
</table>
1124
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Full</label><label for="__tabbed_1_2">Micro</label><label for="__tabbed_1_3">Edge</label></div>
1125
<div class="tabbed-content">
1126
<div class="tabbed-block">
1127
<table>
1128
<thead>
1129
<tr>
1130
<th>Template</th>
1131
<th>Stack</th>
1132
</tr>
1133
</thead>
1134
<tbody>
1135
<tr>
1136
<td><code>django-nextjs</code></td>
1137
<td>Django 5 + Next.js 16 (GraphQL)</td>
1138
</tr>
1139
<tr>
1140
<td><code>rails-nextjs</code></td>
1141
<td>Rails 8 + Next.js 16 (GraphQL)</td>
1142
</tr>
1143
<tr>
1144
<td><code>rails-hotwire</code></td>
1145
<td>Rails 8 + Hotwire + Tailwind</td>
1146
</tr>
1147
<tr>
1148
<td><code>nestjs-nextjs</code></td>
1149
<td>NestJS + Next.js 16 (GraphQL)</td>
1150
</tr>
1151
<tr>
1152
<td><code>laravel-vue</code></td>
1153
<td>Laravel 12 + Vue 3 (Inertia)</td>
1154
</tr>
1155
<tr>
1156
<td><code>spring-angular</code></td>
1157
<td>Spring Boot + Angular 19</td>
1158
</tr>
1159
<tr>
1160
<td><code>go-nextjs</code></td>
1161
<td>Go + Next.js 16 (GraphQL)</td>
1162
</tr>
1163
<tr>
1164
<td><code>remix-full</code></td>
1165
<td>Remix (full-stack)</td>
1166
</tr>
1167
<tr>
1168
<td><code>sveltekit-full</code></td>
1169
<td>SvelteKit (full-stack)</td>
1170
</tr>
1171
<tr>
1172
<td><code>phoenix-liveview</code></td>
1173
<td>Phoenix + LiveView</td>
1174
</tr>
1175
</tbody>
1176
</table>
1177
</div>
1178
<div class="tabbed-block">
1179
<table>
1180
<thead>
1181
<tr>
1182
<th>Template</th>
1183
<th>Stack</th>
1184
</tr>
1185
</thead>
1186
<tbody>
1187
<tr>
1188
<td><code>django-micro</code></td>
1189
<td>Django 5 REST API</td>
1190
</tr>
1191
<tr>
1192
<td><code>fastapi-micro</code></td>
1193
<td>FastAPI + async</td>
1194
</tr>
1195
<tr>
1196
<td><code>nestjs-micro</code></td>
1197
<td>NestJS REST API</td>
1198
</tr>
1199
<tr>
1200
<td><code>rails-micro</code></td>
1201
<td>Rails 8 API mode</td>
1202
</tr>
1203
<tr>
1204
<td><code>laravel-micro</code></td>
1205
<td>Laravel 12 API</td>
1206
</tr>
1207
<tr>
1208
<td><code>spring-micro</code></td>
1209
<td>Spring Boot REST</td>
1210
</tr>
1211
<tr>
1212
<td><code>go-micro</code></td>
1213
<td>Go REST API</td>
1214
</tr>
1215
<tr>
1216
<td><code>express-micro</code></td>
1217
<td>Express + TypeScript</td>
1218
</tr>
1219
<tr>
1220
<td><code>phoenix-micro</code></td>
1221
<td>Phoenix API</td>
1222
</tr>
1223
<tr>
1224
<td><code>rust-micro</code></td>
1225
<td>Axum REST API</td>
1226
</tr>
1227
</tbody>
1228
</table>
1229
</div>
1230
<div class="tabbed-block">
1231
<table>
1232
<thead>
1233
<tr>
1234
<th>Template</th>
1235
<th>Stack</th>
1236
</tr>
1237
</thead>
1238
<tbody>
1239
<tr>
1240
<td><code>sveltekit-edge</code></td>
1241
<td>SvelteKit on Cloudflare Pages</td>
1242
</tr>
1243
<tr>
1244
<td><code>remix-edge</code></td>
1245
<td>Remix on Cloudflare Pages</td>
1246
</tr>
1247
<tr>
1248
<td><code>nextjs-edge</code></td>
1249
<td>Next.js on Cloudflare Pages</td>
1250
</tr>
1251
<tr>
1252
<td><code>astro-edge</code></td>
1253
<td>Astro on Cloudflare Pages</td>
1254
</tr>
1255
<tr>
1256
<td><code>hono-edge</code></td>
1257
<td>Hono on Cloudflare Workers</td>
1258
</tr>
1259
<tr>
1260
<td><code>worker-edge</code></td>
1261
<td>Cloudflare Worker (bare)</td>
1262
</tr>
1263
</tbody>
1264
</table>
1265
</div>
1266
</div>
1267
</div>
1268
<hr />
1269
<h2 id="how-it-works">How It Works<a class="headerlink" href="#how-it-works" title="Permanent link">&para;</a></h2>
1270
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>boilerworks setup → answer 13 questions → writes boilerworks.yaml
1271
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>boilerworks init → reads boilerworks.yaml → clones + renames + git init
1272
</code></pre></div>
1273
<p>The renderer does case-variant string replacement across every text file:</p>
1274
<ul>
1275
<li><code>boilerworks</code> → <code>myproject</code></li>
1276
<li><code>Boilerworks</code> → <code>Myproject</code></li>
1277
<li><code>BOILERWORKS</code> → <code>MYPROJECT</code></li>
1278
</ul>
1279
<p>No Jinja2, no magic. Templates are real repos that boot as-is.</p>
1280
<hr />
1281
<h2 id="infrastructure-optional">Infrastructure (optional)<a class="headerlink" href="#infrastructure-optional" title="Permanent link">&para;</a></h2>
1282
<p>If you select a cloud provider during setup, <code>boilerworks init</code> also clones <a href="https://github.com/ConflictHQ/boilerworks-opscode">boilerworks-opscode</a> — a Terraform repo with full AWS infrastructure (ECS Fargate, RDS, Redis, ALB, Route53, ACM) and GCP/Azure stubs.</p>
1283
<p>Two topology options:</p>
1284
<ul>
1285
<li><strong>Standard</strong> — app and ops land in sibling directories</li>
1286
<li><strong>Omni</strong> — ops lives inside the app repo as <code>ops/</code></li>
1287
</ul>
1288
<hr />
1289
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">&para;</a></h2>
1290
<p>MIT — Copyright &copy; 2026 CONFLICT LLC</p>
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
</article>
1305
</div>
1306
1307
1308
<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>
1309
1310
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1311
</div>
1312
1313
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1314
1315
<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>
1316
Back to top
1317
</button>
1318
1319
</main>
1320
1321
<footer class="md-footer">
1322
1323
<div class="md-footer-meta md-typeset">
1324
<div class="md-footer-meta__inner md-grid">
1325
<div class="md-copyright">
1326
1327
<div class="md-copyright__highlight">
1328
Copyright &copy; 2026 CONFLICT LLC
1329
</div>
1330
1331
1332
Made with
1333
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1334
Material for MkDocs
1335
</a>
1336
1337
</div>
1338
1339
1340
<div class="md-social">
1341
1342
1343
1344
1345
1346
1347
1348
1349
<a href="https://github.com/ConflictHQ/boilerworks" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1350
<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>
1351
</a>
1352
1353
1354
1355
1356
1357
1358
1359
1360
<a href="https://boilerworks.ai" target="_blank" rel="noopener" title="boilerworks.ai" class="md-social__link">
1361
<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="M351.9 280H161c2.9 64.5 17.2 123.9 37.5 167.4 11.4 24.5 23.7 41.8 35.1 52.4 11.2 10.5 18.9 12.2 22.9 12.2s11.7-1.7 22.9-12.2c11.4-10.6 23.7-28 35.1-52.4 20.3-43.5 34.6-102.9 37.5-167.4zm-191-48h190.9c-2.8-64.5-17.1-123.9-37.4-167.4-11.4-24.4-23.7-41.8-35.1-52.4C268.1 1.7 260.4 0 256.4 0s-11.7 1.7-22.9 12.2c-11.4 10.6-23.7 28-35.1 52.4-20.3 43.5-34.6 102.9-37.5 167.4m-48 0c3.5-85.6 25.6-165.1 57.9-217.3C78.7 47.3 10.9 131.2 1.5 232zM1.5 280c9.4 100.8 77.2 184.7 169.3 217.3-32.3-52.2-54.4-131.7-57.9-217.3zm398.4 0c-3.5 85.6-25.6 165.1-57.9 217.3 92.1-32.7 159.9-116.5 169.3-217.3zm111.4-48C501.9 131.2 434.1 47.3 342 14.7c32.3 52.2 54.4 131.7 57.9 217.3z"/></svg>
1362
</a>
1363
1364
</div>
1365
1366
</div>
1367
</div>
1368
</footer>
1369
1370
</div>
1371
<div class="md-dialog" data-md-component="dialog">
1372
<div class="md-dialog__inner md-typeset"></div>
1373
</div>
1374
1375
1376
1377
1378
1379
<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>
1380
1381
1382
<script src="assets/javascripts/bundle.79ae519e.min.js"></script>
1383
1384
1385
</body>
1386
</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