Skip to content

Document CodeRabbit CLI review defaults #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juanpflores wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document CodeRabbit CLI review defaults #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions plugins/coderabbit/skills/coderabbit-review/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,27 @@ Then re-run `coderabbit auth status --agent` and only continue to review command

## Review Commands

Default review:
Default agent review:

```bash
coderabbit review --agent
coderabbit review --agent -t all
```

Common narrower scopes:
CLI defaults to know:

- `coderabbit review` uses plain text output by default.
- `--agent` changes output to structured findings for agent workflows.
- `--type` defaults to `all`, which includes committed, staged, unstaged, and untracked changes.

Comment on lines +45 to +56
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check CodeRabbit CLI help output to verify --type default value

# Check if coderabbit CLI is available and get help for review command
if command -v coderabbit &> /dev/null; then
    echo "=== Checking coderabbit review --help ==="
    coderabbit review --help 2>&1 | rg -A 5 -i "type|--type|-t"
else
    echo "CodeRabbit CLI not found in this environment"
fi

Repository: coderabbitai/codex-plugin

Length of output: 114

🏁 Script executed:

#!/bin/bash
# Read the SKILL.md file to see the exact content at lines 45-56
echo "=== Reading SKILL.md (lines 45-65) ==="
sed -n '45,65p' plugins/coderabbit/skills/coderabbit-review/SKILL.md

Repository: coderabbitai/codex-plugin

Length of output: 711

🏁 Script executed:

#!/bin/bash
# Search for CLI code related to the review command and --type defaults
echo "=== Searching for review command implementation ==="
find . -type f \( -name "*.ts" -o -name "*.js" -o -name "*.md" \) | head -20
echo ""
echo "=== Searching for --type flag definition ==="
rg -i "type.*default|--type" --type ts --type js -A 3 -B 1 | head -50

Repository: coderabbitai/codex-plugin

Length of output: 9784

🏁 Script executed:

#!/bin/bash
# Look for any configuration files or additional documentation about CLI defaults
echo "=== Searching for CLI or review-related documentation ==="
fd -e md | grep -i "review\|cli\|command" | head -20

Repository: coderabbitai/codex-plugin

Length of output: 1233

Clarify redundancy between default command and documented defaults.

The "Default agent review" command on line 48 explicitly includes -t all, but line 55 documents that --type defaults to all. This creates potential confusion for users about whether the flag needs to be specified.

Consider one of these approaches:

  1. Remove -t all from line 48 since it's redundant with the default
  2. Add clarifying text such as: "The -t all flag is shown explicitly for clarity, though all is already the default"
📝 Proposed fix to remove redundant flag 
-coderabbit review --agent -t all
+coderabbit review --agent

Then also update line 60:

-coderabbit review --agent -t all
+coderabbit review --agent
 coderabbit review --agent -t committed
🤖 Prompt for 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.

In `@plugins/coderabbit/skills/coderabbit-review/SKILL.md` around lines 45 - 56,
The example "coderabbit review --agent -t all" redundantly specifies -t all
while the docs already state that `--type` defaults to `all`; either remove `-t
all` from the example so it reads "coderabbit review --agent" or (if you want
explicit clarity) keep the example but add a short parenthetical like "(-t all
shown for clarity; all is the default)" and ensure the explanatory line that
says "`--type` defaults to `all`" remains accurate; update the surrounding text
referencing `--type`/`-t` so there is no contradiction.

Common scopes and comparisons:

```bash
coderabbit review --agent -t all
coderabbit review --agent -t committed
coderabbit review --agent -t uncommitted
coderabbit review --agent --base main
coderabbit review --agent --base-commit <sha>
coderabbit review --agent --dir /path/to/repo
```

If any of `AGENTS.md`, `.coderabbit.yaml`, or `CLAUDE.md` exist in the repo root, pass them with `-c` to improve review quality.
Expand Down