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