Prof documentation

Prof runs Go benchmarks with go test profiling, writes output under bench/<tag>/, and compares two tags for regressions. Use prof ui for menus; use prof auto, prof track, and flags when you need scripts or CI (prof -h).

Terminology

Term	Meaning
Module root	Directory with your go.mod; run Prof from here (same as for go test).
Tag	Label for one run; data lives in bench/<tag>/.
Baseline / current	Two tags you compare (before vs after).
Profile type	One of cpu, memory, mutex, block.

Articles

Article	Purpose
Install Prof	Install binary, try prof ui.
Quickstart	First successful collect and compare.
Working directory and paths	Where benchmarks are found; where files go.
Collect profiling data	prof auto, prof manual.
Compare runs	prof track auto, prof track manual.
Configure collection	prof setup, config_template.json.
Interactive UI and TUI	prof ui, prof tui, prof tui track.
CI and regressions	Gates, exit codes, link to full CI config.
Optional tools	prof tools (also from prof ui).

Source

Prof on GitHub. Full CI schema: CI/CD configuration.