Skip to content

Commit 6da632f

Browse files
DCjanuscodex
andcommitted
feat(skills): add coderabbit cli skill
Co-authored-by: OpenAI Codex <codex@openai.com>
1 parent 1ec0cbd commit 6da632f

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

skills/coderabbit-cli/SKILL.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: coderabbit-cli
3+
description: 指导如何使用 CodeRabbit CLI 进行 Code Review。
4+
---
5+
6+
让 AI agent 调用本地 `coderabbit` CLI,对当前改动做代码审查。重点是选对 diff 范围,并优先使用 `--prompt-only`
7+
8+
## 使用约定
9+
10+
- 这是给 AI agent 用的 review 工具,不是让 agent 代替人类交互式操作 TUI。
11+
- 默认优先 `--prompt-only`,让 CodeRabbit 直接产出给 AI agent 的提示内容。
12+
- 只有在确实需要阅读纯文本 review 原文时,才使用 `--plain`
13+
- 每次只 review 和当前任务直接相关的 diff,避免把无关改动混进审查范围。
14+
- 单次 review 可能较慢,且存在频率限制;不要在短时间内重复触发多轮无意义审查。
15+
- 对用户汇报时,优先总结 CodeRabbit 的有效发现,不要直接大段转储原始输出。
16+
- 向用户汇报整理后的待处理项时,使用数字编号,方便用户按编号指定后续处理项。
17+
- 如果 CodeRabbit 的建议与代码现状或任务目标冲突,agent 应自行判断并说明取舍理由。
18+
- 若最终没有采纳某条建议,应明确写出不采纳原因,例如误报、已有覆盖、与既定约束冲突。
19+
- 推荐流程:先确认当前任务涉及的改动范围,再选择合适的 `review` 参数并运行 `coderabbit review --prompt-only ...`;将输出整理为可执行项,能直接修复的就修复,需要用户决策的再汇报;大改后如有必要,再补一轮 review,默认不要超过 1 到 2 轮。
20+
21+
## 常用命令
22+
23+
```bash
24+
coderabbit review --prompt-only --type uncommitted # 审查当前未提交改动
25+
coderabbit review --prompt-only --base main # 审查当前分支相对 main 的改动
26+
coderabbit review --prompt-only --base-commit HEAD~3 # 审查 HEAD~3 之后引入的改动
27+
coderabbit review --prompt-only --base main --config coderabbit.yaml # 追加仓库内 review 指令文件
28+
coderabbit review --prompt-only --cwd /abs/path/to/repo --base main # 指定目标仓库目录
29+
```
30+
31+
## 参考
32+
33+
- 查看主命令帮助:`coderabbit --help`
34+
- 查看 review 参数:`coderabbit review --help`
35+
- 官方页面:[CodeRabbit CLI page](https://www.coderabbit.ai/cli)

0 commit comments

Comments
 (0)