From 85eb1ab91fc388d05530bc48e54da10a9457c201 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Tue, 24 Feb 2026 19:55:49 +0200 Subject: docs: refresh AGENTS with current TUI/export and test workflow --- AGENTS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index ead2d34..71fec53 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -12,9 +12,12 @@ mage all # Build everything (BPF objects and Go binary) mage test # Run all tests TEST_NAME=TestEventloop mage testWithName # Run specific test go test ./internal -v # Run tests for internal package +mage integrationTest # Build + run integration tests (default parallelism is capped) +INTEGRATION_PARALLEL=1 mage integrationTest # Force serial integration tests mage generate # Generate code (required after modifying tracepoint definitions) mage bench # Run benchmarks mage clean # Clean build artifacts +mage world # Clean + generate + test + build (recommended reset path) ``` ## Code Generation @@ -47,6 +50,15 @@ Generator source code: - **Dashboard tabs**: `/internal/tui/dashboard/` contains tab renderers (overview/syscalls/files/processes/latency/gaps) and tab framework model. - **Export modal**: `/internal/tui/export/model.go` implements the centered modal used for CSV export flow in TUI mode. +## TUI Behavior + +- **Default mode** is TUI (`-plain` disables TUI and prints CSV rows to stdout). +- **TUI trace flow** ingests events into the in-memory stats engine; it does **not** continuously write trace rows to disk. +- **File output in TUI** is explicit export only (`e`), writing `ior-snapshot-.csv` in the current directory. +- **Export toggle flag**: `-tuiExport=true|false` (default `true`) enables or disables TUI snapshot file export at runtime. +- **Tab navigation** supports `tab/shift+tab`, numeric keys `1..6`, and directional keys `left/right` and `h/l`. +- **When export is disabled**, export key hints are hidden from dashboard help and `e` does not open export modal. + ## Code Style - Standard Go conventions with static linking (`-ldflags '-w -extldflags "-static"'`) -- cgit v1.2.3