LGUG2Z
928ee8ebaa
One workflow builds both platforms and publishes what they built. macOS builds and checks through nix on the self-hosted runner; Windows builds natively on `windows-latest` for x86_64 and aarch64, with fmt, clippy and the tests on x86_64. A publish job packages the executables and checksums and writes the release notes with kokai: a `v*` tag makes a release, a scheduled or manual run on master replaces the rolling nightly, and any other push to master makes a draft. There is no nix on the Windows runner, so it checks out the komorebi sources at the revisions `flake.lock` pins.
komorebi-recorder
Synchronized screen, log and trace capture for komorebi bug reproduction. komorebi-recorder records a bug while it
happens, on macOS and on Windows: the screen, komorebi's log, every event komorebi sends its subscribers and the
operating system's own trace, all on one clock, into a single session directory. It then answers, from that
directory alone, what komorebi and the OS were doing at any second of the video and where in the video any log line or
event is: for a person, with a window that plays the recording with everything that happened laid out on a timeline,
and for an agent, with commands that print JSON.
Install
There are no releases yet: build it from source, below.
From source
The repository is a Nix flake. In a checkout:
nix develop # the toolchain and the pinned komorebi sources
cargo install --path komorebi-recorder --locked
nix build makes the macOS binary in ./result/bin, and nix build .#komorebi-recorder-windows cross-compiles
komorebi-recorder.exe and, with it, komorebi-recorder-gui.exe from a Mac. nix run github:LGUG2Z/komorebi-recorder
runs the latest commit without a checkout.
How it fits together
Two things vary independently: the host the recorder runs on (macOS or Windows) and the flavor of komorebi it records (komorebi for Mac or komorebi for Windows). A session records both, so one recorded on Windows can be investigated on a Mac. Every record in a session is stamped on one monotonic clock, and the files in it are never rewritten after they are written.
Crates
komorebi-recorder: the library, thekomorebi-recordercommand and, with the same code, thekomorebi-recorder-guiexecutable (no console window on Windows).
Checks
just check runs formatting, clippy and the tests for macOS, clippy for Windows (the Windows code is type-checked
from a Mac, not run), rustdoc with its warnings as errors for both hosts, and cargo deny. It needs nix develop.
CI runs the same checks, builds both platforms and, for Windows, the installer.
Documentation
cargo doc --workspace --no-deps --open for the code. CONTRIBUTING.md says how to work on it.