Document CodeRabbit CLI review defaults

[juanpflores]

This pull request updates the documentation for the coderabbit review command to clarify its usage, especially when using the --agent flag. The changes make it easier to understand the default behaviors and options for running reviews with different scopes.

Documentation improvements for review commands:

• Clarified that coderabbit review produces plain text output by default, while --agent switches output to structured findings for agent workflows.
• Explained that the --type (-t) flag defaults to all, covering committed, staged, unstaged, and untracked changes.
• Added a list of common review command variations and clarified their usage, including specifying directories and base commits.

Summary by CodeRabbit

• Documentation
  • Clarified the default agent review command and documented its key defaults.
  • Added examples for running reviews against a specific base commit or repository directory.
  • Expanded guidance on available CLI options and review scope selection.
  • Updated usage instructions to better reflect current agent-mode review workflows.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: e4a04591-07bc-451e-a124-809ff9cc64bc

📥 Commits

Reviewing files that changed from the base of the PR and between 5088b7e and 38c8dbe.

📒 Files selected for processing (1)

• plugins/coderabbit/skills/coderabbit-review/SKILL.md

Disabled knowledge base sources:

• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

---

📝 Walkthrough

Walkthrough

The CodeRabbit review skill documentation now shows the default agent review command, documents output and type defaults, and adds scope examples for --base-commit <sha> and --dir /path/to/repo.

Poem

🐰 Clear commands hop into view,
--agent -t all leads reviews through.
Scope flags guide each review run,
With --base-commit and --dir done.

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Document CodeRabbit CLI review defaults' accurately and concisely summarizes the main change: updating documentation to clarify CodeRabbit review command defaults and behaviors.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch coderabbit-cli-defaults

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch coderabbit-cli-defaults

---

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

[coderabbitai]

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 `@plugins/coderabbit/skills/coderabbit-review/SKILL.md`:
- Around line 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.

🪄 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: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: a2cc0f47-b9e5-4007-9669-47f3e01dd512

📥 Commits

Reviewing files that changed from the base of the PR and between 0f66928 and 5088b7e.

📒 Files selected for processing (1)

• plugins/coderabbit/skills/coderabbit-review/SKILL.md

📜 Review details

🔇 Additional comments (1)

plugins/coderabbit/skills/coderabbit-review/SKILL.md (1)

57-93: LGTM!

The "Common scopes and comparisons" examples are clear and well-structured, demonstrating useful command variations. The Output Handling, Result Format, and Guardrails sections provide comprehensive operational guidance with appropriate detail.