CodeRabbit 使用教程：从入门到上手

CodeRabbit 是什么

CodeRabbit 是一个基于 AI 的代码审查工具，专门用来审查 GitHub 上的 Pull Request（PR）。它不像传统代码审查那样依赖人工逐行检查，而是自动分析你的代码变更，给出具体的修改建议、潜在问题和改进方向。简单说，你提交一个 PR，CodeRabbit 就会像一位资深开发者那样，帮你过一遍代码，挑出逻辑错误、安全漏洞、代码风格问题，甚至还能给出整体总结。

核心功能怎么用

CodeRabbit 的核心功能围绕 PR 审查展开，主要分三块：

AI 评论：每次你提交 PR，CodeRabbit 会自动在每条代码变更行下生成评论。比如你改了一行 SQL 查询，它可能会提醒“这里缺少索引，可能导致性能问题”，或者“这个变量命名不够清晰，建议改成更具描述性的名称”。这些评论直接出现在 GitHub 的 PR 页面里，你可以像回复人工审查一样回复它。

整体总结：PR 审查完成后，CodeRabbit 会生成一段总结，放在 PR 的评论区顶部。总结内容包括：本次 PR 改了什么、主要风险点、建议的测试覆盖方向。这个功能特别适合团队负责人快速了解 PR 全貌，不用逐行看代码。

增量审查：如果你在 PR 里修改了代码并重新推送，CodeRabbit 只会审查新增或修改的部分，不会重复分析之前看过的代码。这样既节省时间，也避免信息过载。

第一次上手步骤

1. 安装到 GitHub：打开 CodeRabbit 官网（国内访问可能受限，可搜索类似工具如“CodeReviewer”或“PR-Agent”作为替代），点击“Install for GitHub”，授权它访问你的仓库。你可以选择安装到所有仓库，也可以只选几个。

2. 配置触发规则：安装后，CodeRabbit 默认会在每个 PR 提交时自动运行。如果你只想在特定条件下触发（比如只有标记了“review”标签的 PR 才审查），可以在仓库根目录下创建 .coderabbit.yaml 配置文件。例如：

   reviews:
     enabled: true
     only_review: true
     ignore:
       - "*.md"
   

   这段配置表示只审查代码文件，忽略 Markdown 文档。

3. 提交一个 PR 试试：随便改几行代码，提交 PR。几秒到几十秒后，你会在 PR 页面看到 CodeRabbit 的评论和总结。如果它没反应，检查 GitHub 的 Actions 或 Webhooks 日志，看是否触发了。

4. 调整审查强度：默认情况下，CodeRabbit 的审查比较严格，可能会对代码风格、变量命名等提出很多建议。如果你觉得太吵，可以在配置里设置 severity: low 或 medium，只关注严重问题。

适合什么场景

CodeRabbit 最适合以下场景：

• 个人项目：你一个人写代码，提交 PR 后没人帮你审查。CodeRabbit 能帮你发现低级错误，比如忘记处理 null 值、循环边界写错等。
• 小团队：团队人少，大家都很忙，没时间逐行审查 PR。CodeRabbit 可以分担大部分重复性工作，人工只需要关注它标记的高风险问题。
• 开源项目：维护者收到大量 PR，没精力一一细看。CodeRabbit 可以自动过滤掉有明显问题的 PR，只保留高质量的等待人工审查。

不过要注意，CodeRabbit 不是万能的。它擅长发现模式化问题（比如代码规范、常见漏洞），但对于业务逻辑的深层理解（比如“这个算法是否适合当前场景”）还是需要人工判断。

价格说明

CodeRabbit 提供免费和付费两个版本：

• 免费版：对开源项目完全免费，不限 PR 数量。对私有仓库，每月有 20 次 PR 审查额度，超出后需要升级。
• 付费版（Pro）：起价约 $15/月，包含无限次 PR 审查、更详细的报告、自定义规则、团队协作功能等。如果团队人多，还可以买团队版（Team），按人头计费，价格更高。

如果你只是个人开发者或小团队，免费版通常够用。如果 PR 频繁且需要深度定制，Pro 版更划算。注意，付费需要使用海外支付方式，国内用户可能不太方便，可以考虑前面提到的国产替代工具。