# runbook-tutorials

A user interface specialized to present runbook tutorials that with parameters
can guide through actual IT administration and operation tasks.

- **Intent:** `INTENT.md` · **Scope:** `SCOPE.md`
- **Pack specification:** `docs/pack-spec.md`, schema in `schema/`
- **Packs live where the procedure lives:** `runbooks/<pack>/pack.yaml` in the owning repo.
  Examples: `net-kingdom/runbooks/`, and `runbooks/example-hello/` here.

```bash
python3 -m rtut validate <repo-root>      # validate every pack
python3 -m rtut list <repo-root>          # id, engine, exercise status, title
python3 -m rtut show <pack.yaml>          # steps with owners and done-when
python3 -m rtut render <pack.yaml> <step> -p name=value
python3 -m rtut launch <pack.yaml>        # legacy-command packs: start the existing console
make test
```

Status: the specification, validator and legacy launch work; run state, evidence
and the UI are planned (`workplans/RBT-WP-0003` and `RBT-WP-0004`).