From be6b25d18e170f81438aed045446e8cf5bba57dc Mon Sep 17 00:00:00 2001 From: Chris Geyer Date: Wed, 13 May 2026 21:47:03 +0000 Subject: [PATCH] docs(readme): fix tracer CLI drift, point install at canonical docs The README referenced `roar tracer status` and `roar tracer set-default preload`, neither of which exists. The actual surface is `roar tracer` (status + tradeoff table), `roar tracer use`, `roar tracer check`, and `roar tracer enable`. Updates the Selecting-A-Backend block and the dev-install verify line accordingly, and adds `tracer check` / `tracer enable` since they're useful and weren't surfaced. Adds a callout near the install header pointing at https://glaas.ai/docs/roar-guide#installing-roar as the canonical install reference (full platform matrix, prereqs, macOS SIP notes, sdist build steps). Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3016666..69de183 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,11 @@ uv pip install roar-cli Requires Python 3.10+. +> For the full prereqs, platform support matrix, tracer-backend setup, +> macOS SIP notes, and sdist build steps, see the canonical +> [Installing roar](https://glaas.ai/docs/roar-guide#installing-roar) docs page. +> What's below is a TL;DR. + ### Platform Support | Platform | Status | @@ -148,10 +153,16 @@ By default, `roar` uses `auto` mode: prefer eBPF, then preload, then ptrace. ```bash # Show what roar can currently find and whether it looks usable -roar tracer status +roar tracer # Set a default backend (auto|ebpf|preload|ptrace) -roar tracer set-default preload +roar tracer use preload + +# Deep preflight for one backend, with the exact failure cause +roar tracer check ebpf + +# One-shot host setup for the eBPF backend (applies CAP_BPF) +roar tracer enable ebpf ``` ### macOS Tracing Limitations @@ -647,10 +658,9 @@ rustup component add rust-src --toolchain nightly `scripts/install-dev.sh` skips eBPF gracefully when `bpf-linker` is absent — the other tracers still work. -Verify the install with `roar tracer status`; every backend listed -should be `ready` (or have a clear platform-specific reason it isn't, -like `perf_event_paranoid=4 (needs <= 1)` for eBPF on a hardened -kernel). +Verify the install with `roar tracer`; every backend listed should be +`ready` (or have a clear platform-specific reason it isn't, like +`perf_event_paranoid=4 (needs <= 1)` for eBPF on a hardened kernel). ### Running Quality Checks