docs: sync README and agent guidance with CLI (#455) - #514
Conversation
|
Warning Review limit reached
Next review available in: 4 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c13b64d2cd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Follow any `state rebuild` command with `burn ingest` to repopulate derived | ||
| tables from the harness session stores. Before a forced reset, back up |
There was a problem hiding this comment.
When the ledger is already caught up and its Claude transcripts are unchanged—the normal maintenance scenario—Ledger::rebuild_derivable deletes the derivable rows but deliberately preserves each file's EOF cursor, and ingest_claude_into then skips files whose cursor offset is still at the file size. Consequently, this prescribed follow-up leaves the historical tables empty rather than repopulating or reclassifying them; document a recovery path that actually resets/replays cursors while preserving stamps, or fix rebuild before recommending this workflow.
AGENTS.md reference: AGENTS.md:L118-L121
Useful? React with 👍 / 👎.
| | [`burn state`](#burn-state) | Inspect, rebuild, and prune derived ledger artifacts. | | ||
| | [`burn update`](#burn-update) | Check for releases, install an update, or configure automatic checks. | | ||
|
|
||
| Every command accepts `--json` for machine-readable output, |
There was a problem hiding this comment.
For automation invoking burn ingest --json, the inherited flag parses successfully—as confirmed by burn ingest --help—but the successful one-shot path ignores globals.json and always emits the plain [burn] ingest: ingested ... summary through log_report_oneshot. Scripts following this blanket guarantee therefore receive invalid JSON; exclude commands such as ingest from the claim or implement their structured output.
AGENTS.md reference: AGENTS.md:L118-L121
Useful? React with 👍 / 👎.
1 participant
Fixes #455
Closes #149
The README command reference covers the complete current CLI surface, including sessions, flow, stamps, overhead deltas, ledger fingerprints, byte-ranked hotspots, polling ingest, and both MCP tools. Every documented CLI example is verified against an isolated Burn home.
The local-data section describes the current burn.sqlite and content.sqlite WAL layout, path and retention controls, and the state rebuild, prune, reset, and stamp-backup workflow.
AGENTS.md points contributors to the SDK ingest and live CLI registration surfaces and contains no removed burn run guidance. The Unreleased changelog summarizes the documentation impact.
🤖 Generated with Claude Code.