Skip to content

docs: document the full openers config schema#1356

Open
ChampPABA wants to merge 2 commits into
Fission-AI:mainfrom
ChampPABA:docs/openers-config-fields
Open

docs: document the full openers config schema#1356
ChampPABA wants to merge 2 commits into
Fission-AI:mainfrom
ChampPABA:docs/openers-config-fields

Conversation

@ChampPABA

@ChampPABA ChampPABA commented Jul 14, 2026

Copy link
Copy Markdown

docs/cli.md says the openers key "adds tools or adjusts built-ins per field", but it never lists the fields, and the example only shows style and attach_flag. The schema in src/core/openers.ts accepts five: style, label, command, args, attach_flag.

args is the one that gets missed. It already covers "pass static flags to the launched tool" (the built-in codex opener 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 args on claude.

Docs only, no behavior change.

Summary by CodeRabbit

  • Documentation
    • Updated the Personal worksets configuration example for the Claude tool to use a richer openers structure.
    • Added/clarified documentation for an args option to pass static pre-arguments to tools.
    • Clarified how tool-picker entries behave for built-in tools versus when new tools are added.

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 706583e8-045c-4cc3-927b-e7a09ca4a8d4

📥 Commits

Reviewing files that changed from the base of the PR and between 6a2cc2f and 2c26e4b.

📒 Files selected for processing (1)
  • docs/cli.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/cli.md

📝 Walkthrough

Walkthrough

The CLI documentation updates the Claude opener example to include an args array and clarifies the args and attach_flag configuration fields.

Changes

CLI opener documentation

Layer / File(s) Summary
Document opener configuration
docs/cli.md
The Claude openers example adds an args array, and the field reference explains args, attach_flag, and built-in tool-picker behavior.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: tabishb

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the docs-only change to the openers config schema.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f0cac2bd-7876-4eb0-9213-f60b3d9dbfe7

📥 Commits

Reviewing files that changed from the base of the PR and between 0a99f41 and 6a2cc2f.

📒 Files selected for processing (1)
  • docs/cli.md

Comment thread docs/cli.md
@ChampPABA

Copy link
Copy Markdown
Author

Good catch, fixed in 2c26e4b. The example now uses ["--model", "opus"], which demonstrates args just as well without putting a permission-bypass flag in the docs.

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.

1 participant