Skip to content

Commit a8f4ed6

Browse files
committed
docs(readme): add developer bootstrap instructions for stackctl.sh
Introduce a "Bootstrap (developer setup)" section showing ./stackctl.sh --bootstrap and what it does: - copies missing .env files from .env.example - installs Python requirements when a virtualenv is active - checks Docker installation and Docker Swarm status Notes that the helper is a safe convenience (won't overwrite or commit .env files) and links to tools/README.md for more details.
1 parent a0bd17d commit a8f4ed6

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,22 @@ See `stacks/README.md` for the full runbook or use `stackctl.sh` helpers:
191191
./stackctl.sh up
192192
```
193193

194+
### Bootstrap (developer setup)
195+
196+
To quickly prepare a development machine for working with this repository, there's a helper built into the main wrapper script.
197+
198+
```bash
199+
./stackctl.sh --bootstrap
200+
```
201+
202+
What this does:
203+
- Copies missing `.env` files from `.env.example` where present.
204+
- Installs Python requirements from `tools/requirements.txt` when a Python virtualenv is active.
205+
- Checks that Docker is installed and whether Docker Swarm is active (prints next steps if not).
206+
207+
This is a safe convenience for local setup; it does not commit or overwrite existing `.env` files. See `tools/README.md` for more details about renderers and SOPS usage.
208+
209+
194210
### 3. Set up core infrastructure (Compose - legacy local-only)
195211

196212
```bash

0 commit comments

Comments
 (0)