summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-05-01 10:02:19 +0300
committerPaul Buetow <paul@buetow.org>2026-05-01 10:02:19 +0300
commit0dc3dc4e0c8367bc8399d3987251015a0e135fd9 (patch)
tree5ac7a5455cd9f89c70df429704e97424ffd8baa9 /AGENTS.md
parent92a36a8c5f23756b8c6d721e89450752409ddd75 (diff)
update instructions
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
index ddfdbbf..0d65300 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -25,8 +25,15 @@ env GOTOOLCHAIN=auto mage bench # Run benchmarks
env GOTOOLCHAIN=auto mage prReview # Run PR review baseline: world + benchProf
env GOTOOLCHAIN=auto mage clean # Clean build artifacts
env GOTOOLCHAIN=auto mage world # Clean + generate + test + build (recommended reset path)
+env GOTOOLCHAIN=auto mage demo # Regen demo/ GIFs + screenshots (needs vhs+ttyd, sudo -v warmed)
+TAPE=07-stream-live mage demoOne # Regen one demo tape only
+env GOTOOLCHAIN=auto mage installDemoTools # One-time: install vhs (go install) and ttyd (dnf)
```
+## Demo Pipeline
+
+`demo/` holds the reproducible TUI demo: 14 [VHS](https://github.com/charmbracelet/vhs) `.tape` files under `demo/tapes/` drive every dashboard tab and headless mode, write GIFs and PNGs into `demo/assets/`, and the resulting tutorial is `demo/TUTORIAL.md`. Background workload is generated by `demo/scripts/workload.sh`. `mage demo` is fully headless (no real terminal window) — safe to run in the background while editing code; the only foreground requirement is one `sudo -v` to pre-warm the sudo timestamp.
+
## Code Generation
**Run `mage generate` before building when tracepoint definitions change!**