BoilerWorks

boilerworks / getting-started / quickstart / index.html
Source Rendered
Blame History Raw 1250 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/getting-started/quickstart/">
16
17
18
<link rel="prev" href="../installation/">
19
20
21
<link rel="next" href="../configuration/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
29
30
31
32
<title>Quick Start - Boilerworks</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/css/custom.css">
59
60
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
61
62
63
64
65
66
</head>
67
68
69
70
71
72
73
74
75
76
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
77
78
79
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
80
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
81
<label class="md-overlay" for="__drawer"></label>
82
<div data-md-component="skip">
83
84
85
<a href="#quick-start" class="md-skip">
86
Skip to content
87
</a>
88
89
</div>
90
<div data-md-component="announce">
91
92
</div>
93
94
95
96
97
<header class="md-header" data-md-component="header">
98
<nav class="md-header__inner md-grid" aria-label="Header">
99
<a href="../.." title="Boilerworks" class="md-header__button md-logo" aria-label="Boilerworks" data-md-component="logo">
100
101
<img src="../../assets/images/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
Boilerworks
113
</span>
114
</div>
115
<div class="md-header__topic" data-md-component="header-topic">
116
<span class="md-ellipsis">
117
118
Quick Start
119
120
</span>
121
</div>
122
</div>
123
</div>
124
125
126
<form class="md-header__option" data-md-component="palette">
127
128
129
130
131
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
132
133
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
134
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
135
</label>
136
137
138
139
140
141
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
142
143
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
144
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
145
</label>
146
147
148
</form>
149
150
151
152
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
153
154
155
156
157
158
<label class="md-header__button md-icon" for="__search">
159
160
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
161
</label>
162
<div class="md-search" data-md-component="search" role="dialog">
163
<label class="md-search__overlay" for="__search"></label>
164
<div class="md-search__inner" role="search">
165
<form class="md-search__form" name="search">
166
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
167
<label class="md-search__icon md-icon" for="__search">
168
169
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
172
</label>
173
<nav class="md-search__options" aria-label="Search">
174
175
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
176
177
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
178
</button>
179
</nav>
180
181
<div class="md-search__suggest" data-md-component="search-suggest"></div>
182
183
</form>
184
<div class="md-search__output">
185
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
186
<div class="md-search-result" data-md-component="search-result">
187
<div class="md-search-result__meta">
188
Initializing search
189
</div>
190
<ol class="md-search-result__list" role="presentation"></ol>
191
</div>
192
</div>
193
</div>
194
</div>
195
</div>
196
197
198
199
<div class="md-header__source">
200
<a href="https://github.com/ConflictHQ/boilerworks" 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/boilerworks
207
</div>
208
</a>
209
</div>
210
211
</nav>
212
213
</header>
214
215
<div class="md-container" data-md-component="container">
216
217
218
219
220
221
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
222
<div class="md-grid">
223
<ul class="md-tabs__list">
224
225
226
227
228
229
230
<li class="md-tabs__item">
231
<a href="../.." class="md-tabs__link">
232
233
234
235
236
237
Home
238
239
</a>
240
</li>
241
242
243
244
245
246
247
248
249
250
251
252
253
<li class="md-tabs__item md-tabs__item--active">
254
<a href="../installation/" class="md-tabs__link">
255
256
257
258
Getting Started
259
260
</a>
261
</li>
262
263
264
265
266
267
268
269
270
271
272
273
<li class="md-tabs__item">
274
<a href="../../guide/templates/" class="md-tabs__link">
275
276
277
278
Templates
279
280
</a>
281
</li>
282
283
284
285
286
287
288
289
290
291
292
293
<li class="md-tabs__item">
294
<a href="../../cli/setup/" class="md-tabs__link">
295
296
297
298
CLI Reference
299
300
</a>
301
</li>
302
303
304
305
306
307
308
309
310
311
<li class="md-tabs__item">
312
<a href="../../contributing/" class="md-tabs__link">
313
314
315
316
317
318
Contributing
319
320
</a>
321
</li>
322
323
324
325
</ul>
326
</div>
327
</nav>
328
329
330
331
<main class="md-main" data-md-component="main">
332
<div class="md-main__inner md-grid">
333
334
335
336
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
337
<div class="md-sidebar__scrollwrap">
338
<div class="md-sidebar__inner">
339
340
341
342
343
344
345
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
346
<label class="md-nav__title" for="__drawer">
347
<a href="../.." title="Boilerworks" class="md-nav__button md-logo" aria-label="Boilerworks" data-md-component="logo">
348
349
<img src="../../assets/images/logo.svg" alt="logo">
350
351
</a>
352
Boilerworks
353
</label>
354
355
<div class="md-nav__source">
356
<a href="https://github.com/ConflictHQ/boilerworks" title="Go to repository" class="md-source" data-md-component="source">
357
<div class="md-source__icon md-icon">
358
359
<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>
360
</div>
361
<div class="md-source__repository">
362
ConflictHQ/boilerworks
363
</div>
364
</a>
365
</div>
366
367
<ul class="md-nav__list" data-md-scrollfix>
368
369
370
371
372
373
374
375
<li class="md-nav__item">
376
<a href="../.." class="md-nav__link">
377
378
379
380
<span class="md-ellipsis">
381
382
383
Home
384
385
386
387
</span>
388
389
390
391
</a>
392
</li>
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
418
419
420
421
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
422
423
424
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
425
426
427
428
<span class="md-ellipsis">
429
430
431
Getting Started
432
433
434
435
</span>
436
437
438
439
<span class="md-nav__icon md-icon"></span>
440
</label>
441
442
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
443
<label class="md-nav__title" for="__nav_2">
444
<span class="md-nav__icon md-icon"></span>
445
446
447
Getting Started
448
449
450
</label>
451
<ul class="md-nav__list" data-md-scrollfix>
452
453
454
455
456
457
458
459
<li class="md-nav__item">
460
<a href="../installation/" class="md-nav__link">
461
462
463
464
<span class="md-ellipsis">
465
466
467
Installation
468
469
470
471
</span>
472
473
474
475
</a>
476
</li>
477
478
479
480
481
482
483
484
485
486
487
488
489
<li class="md-nav__item md-nav__item--active">
490
491
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
492
493
494
495
496
497
<label class="md-nav__link md-nav__link--active" for="__toc">
498
499
500
501
<span class="md-ellipsis">
502
503
504
Quick Start
505
506
507
508
</span>
509
510
511
512
<span class="md-nav__icon md-icon"></span>
513
</label>
514
515
<a href="./" class="md-nav__link md-nav__link--active">
516
517
518
519
<span class="md-ellipsis">
520
521
522
Quick Start
523
524
525
526
</span>
527
528
529
530
</a>
531
532
533
534
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
535
536
537
538
539
540
541
<label class="md-nav__title" for="__toc">
542
<span class="md-nav__icon md-icon"></span>
543
Table of contents
544
</label>
545
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
546
547
<li class="md-nav__item">
548
<a href="#1-install" class="md-nav__link">
549
<span class="md-ellipsis">
550
551
1. Install
552
553
</span>
554
</a>
555
556
</li>
557
558
<li class="md-nav__item">
559
<a href="#2-pick-a-template" class="md-nav__link">
560
<span class="md-ellipsis">
561
562
2. Pick a template
563
564
</span>
565
</a>
566
567
</li>
568
569
<li class="md-nav__item">
570
<a href="#3-run-the-wizard" class="md-nav__link">
571
<span class="md-ellipsis">
572
573
3. Run the wizard
574
575
</span>
576
</a>
577
578
</li>
579
580
<li class="md-nav__item">
581
<a href="#4-generate" class="md-nav__link">
582
<span class="md-ellipsis">
583
584
4. Generate
585
586
</span>
587
</a>
588
589
</li>
590
591
<li class="md-nav__item">
592
<a href="#5-boot-it" class="md-nav__link">
593
<span class="md-ellipsis">
594
595
5. Boot it
596
597
</span>
598
</a>
599
600
</li>
601
602
<li class="md-nav__item">
603
<a href="#what-you-get" class="md-nav__link">
604
<span class="md-ellipsis">
605
606
What you get
607
608
</span>
609
</a>
610
611
</li>
612
613
</ul>
614
615
</nav>
616
617
</li>
618
619
620
621
622
623
624
625
626
627
628
<li class="md-nav__item">
629
<a href="../configuration/" class="md-nav__link">
630
631
632
633
<span class="md-ellipsis">
634
635
636
Configuration
637
638
639
640
</span>
641
642
643
644
</a>
645
</li>
646
647
648
649
650
</ul>
651
</nav>
652
653
</li>
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
<li class="md-nav__item md-nav__item--nested">
674
675
676
677
678
679
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
680
681
682
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
683
684
685
686
<span class="md-ellipsis">
687
688
689
Templates
690
691
692
693
</span>
694
695
696
697
<span class="md-nav__icon md-icon"></span>
698
</label>
699
700
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
701
<label class="md-nav__title" for="__nav_3">
702
<span class="md-nav__icon md-icon"></span>
703
704
705
Templates
706
707
708
</label>
709
<ul class="md-nav__list" data-md-scrollfix>
710
711
712
713
714
715
716
717
<li class="md-nav__item">
718
<a href="../../guide/templates/" class="md-nav__link">
719
720
721
722
<span class="md-ellipsis">
723
724
725
Catalogue
726
727
728
729
</span>
730
731
732
733
</a>
734
</li>
735
736
737
738
739
740
741
742
743
744
745
<li class="md-nav__item">
746
<a href="../../guide/choosing/" class="md-nav__link">
747
748
749
750
<span class="md-ellipsis">
751
752
753
Choosing a Template
754
755
756
757
</span>
758
759
760
761
</a>
762
</li>
763
764
765
766
767
</ul>
768
</nav>
769
770
</li>
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
<li class="md-nav__item md-nav__item--nested">
791
792
793
794
795
796
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
797
798
799
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
800
801
802
803
<span class="md-ellipsis">
804
805
806
CLI Reference
807
808
809
810
</span>
811
812
813
814
<span class="md-nav__icon md-icon"></span>
815
</label>
816
817
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
818
<label class="md-nav__title" for="__nav_4">
819
<span class="md-nav__icon md-icon"></span>
820
821
822
CLI Reference
823
824
825
</label>
826
<ul class="md-nav__list" data-md-scrollfix>
827
828
829
830
831
832
833
834
<li class="md-nav__item">
835
<a href="../../cli/setup/" class="md-nav__link">
836
837
838
839
<span class="md-ellipsis">
840
841
842
setup
843
844
845
846
</span>
847
848
849
850
</a>
851
</li>
852
853
854
855
856
857
858
859
860
861
862
<li class="md-nav__item">
863
<a href="../../cli/init/" class="md-nav__link">
864
865
866
867
<span class="md-ellipsis">
868
869
870
init
871
872
873
874
</span>
875
876
877
878
</a>
879
</li>
880
881
882
883
884
885
886
887
888
889
890
<li class="md-nav__item">
891
<a href="../../cli/list/" class="md-nav__link">
892
893
894
895
<span class="md-ellipsis">
896
897
898
list
899
900
901
902
</span>
903
904
905
906
</a>
907
</li>
908
909
910
911
912
913
914
915
916
917
918
<li class="md-nav__item">
919
<a href="../../cli/bootstrap/" class="md-nav__link">
920
921
922
923
<span class="md-ellipsis">
924
925
926
bootstrap
927
928
929
930
</span>
931
932
933
934
</a>
935
</li>
936
937
938
939
940
</ul>
941
</nav>
942
943
</li>
944
945
946
947
948
949
950
951
952
953
<li class="md-nav__item">
954
<a href="../../contributing/" class="md-nav__link">
955
956
957
958
<span class="md-ellipsis">
959
960
961
Contributing
962
963
964
965
</span>
966
967
968
969
</a>
970
</li>
971
972
973
974
</ul>
975
</nav>
976
</div>
977
</div>
978
</div>
979
980
981
982
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
983
<div class="md-sidebar__scrollwrap">
984
<div class="md-sidebar__inner">
985
986
987
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
988
989
990
991
992
993
994
<label class="md-nav__title" for="__toc">
995
<span class="md-nav__icon md-icon"></span>
996
Table of contents
997
</label>
998
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
999
1000
<li class="md-nav__item">
1001
<a href="#1-install" class="md-nav__link">
1002
<span class="md-ellipsis">
1003
1004
1. Install
1005
1006
</span>
1007
</a>
1008
1009
</li>
1010
1011
<li class="md-nav__item">
1012
<a href="#2-pick-a-template" class="md-nav__link">
1013
<span class="md-ellipsis">
1014
1015
2. Pick a template
1016
1017
</span>
1018
</a>
1019
1020
</li>
1021
1022
<li class="md-nav__item">
1023
<a href="#3-run-the-wizard" class="md-nav__link">
1024
<span class="md-ellipsis">
1025
1026
3. Run the wizard
1027
1028
</span>
1029
</a>
1030
1031
</li>
1032
1033
<li class="md-nav__item">
1034
<a href="#4-generate" class="md-nav__link">
1035
<span class="md-ellipsis">
1036
1037
4. Generate
1038
1039
</span>
1040
</a>
1041
1042
</li>
1043
1044
<li class="md-nav__item">
1045
<a href="#5-boot-it" class="md-nav__link">
1046
<span class="md-ellipsis">
1047
1048
5. Boot it
1049
1050
</span>
1051
</a>
1052
1053
</li>
1054
1055
<li class="md-nav__item">
1056
<a href="#what-you-get" class="md-nav__link">
1057
<span class="md-ellipsis">
1058
1059
What you get
1060
1061
</span>
1062
</a>
1063
1064
</li>
1065
1066
</ul>
1067
1068
</nav>
1069
</div>
1070
</div>
1071
</div>
1072
1073
1074
1075
<div class="md-content" data-md-component="content">
1076
1077
<article class="md-content__inner md-typeset">
1078
1079
1080
1081
1082
1083
1084
1085
1086
<h1 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h1>
1087
<p>Get a working project in under 5 minutes.</p>
1088
<h2 id="1-install">1. Install<a class="headerlink" href="#1-install" title="Permanent link">&para;</a></h2>
1089
<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
1090
</code></pre></div>
1091
<h2 id="2-pick-a-template">2. Pick a template<a class="headerlink" href="#2-pick-a-template" title="Permanent link">&para;</a></h2>
1092
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>boilerworks<span class="w"> </span>list
1093
</code></pre></div>
1094
<p>This shows all 26 templates with size, language, and description.</p>
1095
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>boilerworks<span class="w"> </span>list<span class="w"> </span>--size<span class="w"> </span>full<span class="w"> </span><span class="c1"># only Full templates</span>
1096
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>boilerworks<span class="w"> </span>list<span class="w"> </span>--language<span class="w"> </span>python<span class="w"> </span><span class="c1"># only Python templates</span>
1097
</code></pre></div>
1098
<h2 id="3-run-the-wizard">3. Run the wizard<a class="headerlink" href="#3-run-the-wizard" title="Permanent link">&para;</a></h2>
1099
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>boilerworks<span class="w"> </span>setup
1100
</code></pre></div>
1101
<p>The wizard asks 13 questions:</p>
1102
<ol>
1103
<li><strong>Project name</strong> — slug format (e.g. <code>my-app</code>)</li>
1104
<li><strong>Template size</strong> — Full / Micro / Edge</li>
1105
<li><strong>Template family</strong> — filtered list based on size</li>
1106
<li><strong>Topology</strong> — standard (separate repos) or omni (monorepo)</li>
1107
<li><strong>Cloud provider</strong> — aws / gcp / azure / none</li>
1108
<li><strong>Infrastructure</strong> — include boilerworks-opscode? (yes/no, if cloud selected)</li>
1109
<li><strong>Region</strong> — e.g. <code>us-east-1</code></li>
1110
<li><strong>Domain</strong> — e.g. <code>myapp.com</code></li>
1111
<li><strong>Mobile</strong> — include mobile template? (Full only)</li>
1112
<li><strong>Web presence</strong> — include marketing site? (Full only)</li>
1113
<li><strong>Compliance</strong> — SOC2 / HIPAA / PCI-DSS / GDPR</li>
1114
<li><strong>Email provider</strong> — SES / SendGrid / Mailgun</li>
1115
<li><strong>E2E testing</strong> — Playwright / Cypress</li>
1116
</ol>
1117
<p>Writes <code>boilerworks.yaml</code> to the current directory.</p>
1118
<h2 id="4-generate">4. Generate<a class="headerlink" href="#4-generate" title="Permanent link">&para;</a></h2>
1119
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>boilerworks<span class="w"> </span>init
1120
</code></pre></div>
1121
<p>This:</p>
1122
<ol>
1123
<li>Clones the template from <code>ConflictHQ/boilerworks-{family}</code></li>
1124
<li>Removes <code>.git/</code></li>
1125
<li>Replaces all <code>boilerworks</code> strings with your project name (case-variant)</li>
1126
<li>Renames any files/directories containing <code>boilerworks</code></li>
1127
<li>If cloud + ops selected: clones <code>boilerworks-opscode</code> and configures it</li>
1128
<li>Runs <code>git init</code> + initial commit</li>
1129
</ol>
1130
<h2 id="5-boot-it">5. Boot it<a class="headerlink" href="#5-boot-it" title="Permanent link">&para;</a></h2>
1131
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nb">cd</span><span class="w"> </span>my-app
1132
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
1133
</code></pre></div>
1134
<p>Visit <code>http://localhost:3000</code>. Your app is running with your project name everywhere.</p>
1135
<h2 id="what-you-get">What you get<a class="headerlink" href="#what-you-get" title="Permanent link">&para;</a></h2>
1136
<p>Every Full template ships with:</p>
1137
<ul>
1138
<li>User auth (login, logout, session management)</li>
1139
<li>Group-based permissions</li>
1140
<li>Items + Categories CRUD</li>
1141
<li>Form definitions + submissions</li>
1142
<li>Workflow definitions + instances</li>
1143
<li>Admin dashboard</li>
1144
<li>Background jobs</li>
1145
<li>PostgreSQL 16 + Redis 7</li>
1146
<li>Docker Compose (dev) + Dockerfile (prod)</li>
1147
<li>Health check endpoint</li>
1148
<li>RSpec / pytest tests</li>
1149
<li>CI pipeline</li>
1150
</ul>
1151
<div class="admonition tip">
1152
<p class="admonition-title">Dry run first</p>
1153
<p>Not sure what will happen? Run <code>boilerworks init --dry-run</code> to see the full plan without touching the filesystem.</p>
1154
</div>
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
</article>
1169
</div>
1170
1171
1172
<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>
1173
1174
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1175
</div>
1176
1177
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1178
1179
<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>
1180
Back to top
1181
</button>
1182
1183
</main>
1184
1185
<footer class="md-footer">
1186
1187
<div class="md-footer-meta md-typeset">
1188
<div class="md-footer-meta__inner md-grid">
1189
<div class="md-copyright">
1190
1191
<div class="md-copyright__highlight">
1192
Copyright &copy; 2026 CONFLICT LLC
1193
</div>
1194
1195
1196
Made with
1197
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1198
Material for MkDocs
1199
</a>
1200
1201
</div>
1202
1203
1204
<div class="md-social">
1205
1206
1207
1208
1209
1210
1211
1212
1213
<a href="https://github.com/ConflictHQ/boilerworks" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1214
<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>
1215
</a>
1216
1217
1218
1219
1220
1221
1222
1223
1224
<a href="https://boilerworks.ai" target="_blank" rel="noopener" title="boilerworks.ai" class="md-social__link">
1225
<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>
1226
</a>
1227
1228
</div>
1229
1230
</div>
1231
</div>
1232
</footer>
1233
1234
</div>
1235
<div class="md-dialog" data-md-component="dialog">
1236
<div class="md-dialog__inner md-typeset"></div>
1237
</div>
1238
1239
1240
1241
1242
1243
<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>
1244
1245
1246
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1247
1248
1249
</body>
1250
</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