BoilerWorks
|
1
|
# Installation |
|
2
|
|
|
3
|
## Requirements |
|
4
|
|
|
5
|
- Python 3.12+ |
|
6
|
- Git |
|
7
|
- SSH key or `gh auth login` for GitHub access (templates are cloned from ConflictHQ) |
|
8
|
|
|
9
|
## Install |
|
10
|
|
|
11
|
=== "pip" |
|
12
|
|
|
13
|
```bash |
|
14
|
pip install boilerworks |
|
15
|
``` |
|
16
|
|
|
17
|
=== "pipx (recommended)" |
|
18
|
|
|
19
|
```bash |
|
20
|
pipx install boilerworks |
|
21
|
``` |
|
22
|
|
|
23
|
=== "uv" |
|
24
|
|
|
25
|
```bash |
|
26
|
uv tool install boilerworks |
|
27
|
``` |
|
28
|
|
|
29
|
## Verify |
|
30
|
|
|
31
|
```bash |
|
32
|
boilerworks --help |
|
33
|
``` |
|
34
|
|
|
35
|
``` |
|
36
|
Usage: boilerworks [OPTIONS] COMMAND [ARGS]... |
|
37
|
|
|
38
|
Boilerworks CLI — project scaffolding from the boilerworks.ai catalogue. |
|
39
|
|
|
40
|
Commands: |
|
41
|
setup Run the interactive setup wizard → writes boilerworks.yaml |
|
42
|
init Generate a project from boilerworks.yaml |
|
43
|
list List all available templates |
|
44
|
bootstrap Run Terraform infrastructure layers (requires cloud setup) |
|
45
|
``` |
|
46
|
|
|
47
|
## GitHub Access |
|
48
|
|
|
49
|
Templates are cloned from `github.com/ConflictHQ`. The CLI tries SSH first, then HTTPS. |
|
50
|
|
|
51
|
**SSH (recommended):** |
|
52
|
```bash |
|
53
|
# Add your key to GitHub if you haven't already |
|
54
|
ssh-add ~/.ssh/id_ed25519 |
|
55
|
ssh -T [email protected] # should say "Hi <username>" |
|
56
|
``` |
|
57
|
|
|
58
|
**HTTPS via gh CLI:** |
|
59
|
```bash |
|
60
|
gh auth login |
|
61
|
``` |
|
62
|
|