BoilerWorks

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

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button