feat(annotate): mark the timeline from a script while recording

`komorebi-recorder mark "text"` appends a point note (author script) to the
session being recorded, found by --session, KOMOREBI_RECORDER_SESSION or the
newest running recording. Notes now show as ticks on the viewer's bug lane.
This commit is contained in:
LGUG2Z committed 2026-10-28 16:24:29 -07:00
1 parent cf15fc978c
commit f9f4e437e4
10 files changed
+596 -2

No files matched your search

+1
View File
@@ -128,6 +128,7 @@ and `event:12.end` when it finished.
| `blank --region x,y,w,h` | When a region was blank (one colour, named: `white`, `black`, a hex code) or frozen (identical to the frame before): "the window went white for 200 ms" |
| `compare A B` | Two recordings side by side: duration, frames, effective fps, worst frame gap, motion, findings by kind, annotations, and the difference |
| `annotate`, `annotations` | Add, change and list bug regions, notes and findings |
| `mark TEXT` | While recording: drop a named point note (author `script`) onto the timeline from a script; it then appears in `annotations`, `brief` and the viewer like any note |
### Who changed it
+17
View File
@@ -127,6 +127,23 @@ This is what makes the recording useful to whoever investigates it, person or ag
truth of _what_ went wrong, and everything else in the session is evidence of _why_. See
[Investigating a recording](investigating-a-recording.md#marking-the-bug).
### Marking steps from a script
A script that performs the repro can drop named markers onto the timeline while the recording is going:
```
komorebi-recorder mark "step 3: move window right"
```
A marker is a note by the author `script`, written at the moment the command runs, so it appears in `annotations`,
`brief`, `search`, `overview` and as a tick on the viewer's bug lane. `mark` prints the video time (`marked 00:03.28 (a-3f9c1e02): ...`) once the first frame has been captured and
the wall time (`marked 12:00:08.12Z (...)`) before that.
It marks the session named by `--session DIR`, else by the environment variable `KOMOREBI_RECORDER_SESSION` (which
`record --until-exit` sets for the command it runs), else the newest recording in komorebi's data directory that is
still running. A recording that has finished is refused: it has no "now" to mark; use `annotate <session> add` with a
time instead. `--json` prints the `mark/1` envelope.
### Without video
`komorebi-recorder record --no-video` records everything but the screen: komorebi's events and log, the OS trace and