BoilerWorks
|
1
|
# boilerworks setup |
|
2
|
|
|
3
|
Run the interactive setup wizard. Asks questions about your project and writes `boilerworks.yaml`. |
|
4
|
|
|
5
|
```bash |
|
6
|
boilerworks setup |
|
7
|
boilerworks setup --output /path/to/boilerworks.yaml |
|
8
|
``` |
|
9
|
|
|
10
|
## Options |
|
11
|
|
|
12
|
| Option | Description | |
|
13
|
|--------|-------------| |
|
14
|
| `--output PATH` | Where to write the manifest (default: `boilerworks.yaml` in cwd) | |
|
15
|
|
|
16
|
## Questions |
|
17
|
|
|
18
|
The wizard walks through 13 steps: |
|
19
|
|
|
20
|
1. **Project name** — validated slug (lowercase, letters/digits/hyphens, must start with a letter) |
|
21
|
2. **Template size** — Full / Micro / Edge (with a guide panel) |
|
22
|
3. **Template family** — filtered by size, shown as a Rich table with status indicators |
|
23
|
4. **Topology** — standard, omni, or api-only (filtered to what the template supports) |
|
24
|
5. **Cloud provider** — aws / gcp / azure / none |
|
25
|
6. **Infrastructure** — include boilerworks-opscode? (shown only if cloud is selected) |
|
26
|
7. **Region** — default varies by cloud |
|
27
|
8. **Domain** — optional |
|
28
|
9. **Mobile** — include mobile template? (Full templates only) |
|
29
|
10. **Web presence** — include marketing site? (Full templates only) |
|
30
|
11. **Compliance** — multi-select: soc2, hipaa, pci-dss, gdpr |
|
31
|
12. **Email provider** — ses / sendgrid / mailgun / none |
|
32
|
13. **E2E testing** — playwright / cypress / none |
|
33
|
|
|
34
|
A summary panel shows all selections before writing. |
|
35
|
|
|
36
|
## Output |
|
37
|
|
|
38
|
```yaml |
|
39
|
# boilerworks.yaml |
|
40
|
project: my-app |
|
41
|
family: django-nextjs |
|
42
|
size: full |
|
43
|
topology: standard |
|
44
|
cloud: aws |
|
45
|
ops: true |
|
46
|
region: us-east-1 |
|
47
|
domain: myapp.com |
|
48
|
... |
|
49
|
``` |
|
50
|
|
|
51
|
Pass this file to `boilerworks init` to generate the project. |
|
52
|
|