docs: document the full openers config schema - #1356
Conversation
|
Warning Review limit reached
Next review available in: 5 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. 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: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe CLI documentation updates the Claude opener example to include an ChangesCLI opener documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/cli.md`:
- Around line 368-374: Update the “claude” CLI example to avoid silently
disabling permission checks: replace “--dangerously-skip-permissions” with a
neutral example flag, or add an explicit warning that it is only appropriate for
trusted or sandboxed workspaces.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
Good catch, fixed in 2c26e4b. The example now uses |
docs/cli.mdsays theopenerskey "adds tools or adjusts built-ins per field", but it never lists the fields, and the example only showsstyleandattach_flag. The schema insrc/core/openers.tsaccepts five:style,label,command,args,attach_flag.argsis the one that gets missed. It already covers "pass static flags to the launched tool" (the built-incodexopener uses it to ship--sandbox workspace-write), but because it is undocumented, the two-field example reads as the whole schema and the capability gets filed as missing (#1347).Adds a field table under the existing example, and extends the example to show
argsonclaude.Docs only, no behavior change.
Summary by CodeRabbit
openersstructure.argsoption to pass static pre-arguments to tools.