coulomb/runbook-tutorials
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A userinterface specialized to present runbook tutorials that with parameters can guide through actual it administration and operation tasks.
71 commits 1 branch 0 tags 1.4 MiB
Find a file
tegwick 6d70f4d97d Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Assistant: claude-code
Assistant-Model: sonnet
Assistant-Process: 295952@bnt-lap001
Assistant-Session: e93f64ad-516c-46eb-9666-aad8d300c477
2026-09-29 21:35:03 +02:00
.claude/rules Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
.forgejo/workflows Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
attribute-sets Maturity from run history, pack revision digests, attribute sets, projects and templates (RBT-WP-0008) 2026-09-29 12:36:34 +02:00
docs Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 2026-09-29 21:35:03 +02:00
project-templates Maturity from run history, pack revision digests, attribute sets, projects and templates (RBT-WP-0008) 2026-09-29 12:36:34 +02:00
projects/trial-1 Projects have their own name, description and goal; the template is shown only as origin 2026-09-29 14:12:21 +02:00
registry Add runbook pack spec, validator, legacy launcher, and workplans RBT-WP-0002..0006 2026-09-29 00:24:05 +02:00
rtut Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 2026-09-29 21:35:03 +02:00
runbooks Retire exercise_status: maturity is the only notion; add CLI tests (RBT-WP-0009-T01) 2026-09-29 21:28:56 +02:00
tests Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 2026-09-29 21:35:03 +02:00
workplans Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 2026-09-29 21:35:03 +02:00
.custodian-brief.md chore(consistency): sync task status from DB [auto] 2026-09-29 20:09:08 +02:00
.gitignore Add run records, step state machine, verification and exercise-status diff (RBT-WP-0003) 2026-09-29 00:43:38 +02:00
.repo-classification.yaml Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
AGENTS.md Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
CLAUDE.md Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
INTENT.md Retire exercise_status: maturity is the only notion; add CLI tests (RBT-WP-0009-T01) 2026-09-29 21:28:56 +02:00
LICENSE Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
Makefile Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
pyproject.toml Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
README.md Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
SCOPE.md Retire exercise_status: maturity is the only notion; add CLI tests (RBT-WP-0009-T01) 2026-09-29 21:28:56 +02:00
WORK-RECORDS.md Sync consistency output 2026-09-29 20:09:09 +02:00

README.md

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 (v0.1, runnable) and docs/pack-spec-v0.2.md (v0.2: stages, gates, datapoints, actors, modes; validates, not yet runnable). Schemas in rtut/schema/. UX findings: docs/ux-review-2026-09-29.md
  • Packs live where the procedure lives: runbooks/<pack>/pack.yaml in the owning repo. Examples: net-kingdom/runbooks/, and here runbooks/example-hello/ and runbooks/showcase-lighthouse/ (a harmless story to try the UI on).

Install

Python 3.12 or newer.

make install        # editable install with the test dependencies (pip install -e ".[test]")
make check          # validate every pack, attribute set, project and template
make test           # run the tests

A plain pip install . works too and provides the rtut command; the JSON schemas ship inside the package.

python3 -m rtut validate <repo-root>      # validate every pack
python3 -m rtut list <repo-root>          # id, engine, maturity, 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
python3 -m rtut maturity <pack.yaml>      # draft | reviewed | rehearsed | proven | stale, from run history
python3 -m rtut review <pack.yaml> --by you     # record a review of the current revision
python3 -m rtut project list|validate|status|attrs|new|run <repo-root> ...   # projects, attribute sets, templates
python3 -m rtut ui <repo-root> [<repo-root> ...]   # local web UI on 127.0.0.1:8877: projects, templates, runbooks; v0.1 and v0.2 runs (guided flow, data view, overview)
python3 -m rtut run new|start|verify|done|finalize <pack.yaml> ...   # the same run record from the terminal
make test

Status: see SCOPE.md; the workplans are in workplans/.