Skip to content

docs(readme): fix tracer CLI drift, point install at canonical docs#103

Merged
TrevorBasinger merged 1 commit into
mainfrom
cg/readme-cli-drift
May 14, 2026
Merged

docs(readme): fix tracer CLI drift, point install at canonical docs#103
TrevorBasinger merged 1 commit into
mainfrom
cg/readme-cli-drift

Conversation

@christophergeyer
Copy link
Copy Markdown
Member

Summary

  • Fix CLI drift in the README's tracer section: roar tracer statusroar tracer, roar tracer set-default preloadroar tracer use preload (the status and set-default subcommands don't exist; roar/cli/commands/tracer.py is the source of truth — roar tracer, use, check, enable).
  • Surface roar tracer check and roar tracer enable in the same block, since they're useful and the README didn't mention them.
  • Add a callout near the install header pointing at Installing roar as the canonical install reference (full platform matrix, prereqs, macOS SIP notes, sdist build steps). README stays as a TL;DR; the docs page is the source of truth so the two can't drift again.

Test plan

  • cat README.md | grep -E 'roar tracer (status|set-default)' returns nothing (drift gone).
  • roar tracer --help, roar tracer use --help, roar tracer check --help, roar tracer enable --help all resolve (sanity-check the README matches the actual CLI).
  • The docs link https://glaas.ai/docs/roar-guide#installing-roar resolves to the install section once the corresponding docs PR ships.

🤖 Generated with Claude Code

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) <noreply@anthropic.com>
@TrevorBasinger TrevorBasinger merged commit e82b260 into main May 14, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants