ai-pre-commit-review
v0.1.2
Published
Local AI pre-commit code review CLI for staged Git changes.
Maintainers
Readme
ai-pre-commit-review
ai-pre-commit-review 是一个Git pre-commit AI code review 工具。它读取当前
staged diff,调用本机 agent CLI(Claude、Codex 或 Gemini)审查提交内容,并允许 agent
直接修改不合适的代码。如果 agent 没有改动工作树,本次 commit 正常继续;如果 agent
应用了修复,工具会终止本次 commit,且不会重新暂存任何内容。修复会留在 working tree
里由开发者检查、暂存后再次提交。
它能做什么
- 在
git commit前审查 staged changes。 - 支持
claude、codex、gemini三种本地 CLI backend。 - 不接收 webhook,不运行 HTTP server,不依赖 GitLab、SQLite 或后台 worker。
- Agent 只拿到 staged file list 和 staged diff;prompt 明确要求不要提交、建分支或改非 staged 文件。
- Agent 不会运行
git add;修正后的代码是否进入后续 commit 由开发者决定。 - 如果 agent 修改了 staged 文件的 working tree diff,pre-commit 返回 1 并阻止本次提交。
ai-pre-commit-review 使用方法
安装方法
1.安装agent CLI 并授权登录,以codex为例
npm install -g @openai/codex
codex --version2.安装bun:
PS:这个包依赖 Bun 运行,所以需要安装bun
curl -fsSL https://bun.sh/install | bash
bun --version3.全局安装ai-pre-commit-review
npm install -g ai-pre-commit-review确认命令可用:
ai-pre-commit-review --help使用方法
1. 手动 review 当前项目
进入任意 Git 项目:
cd /path/to/your/repo先暂存改动:
git add <files>执行 review:
ai-pre-commit-review也可以 review 指定项目:
ai-pre-commit-review /path/to/your/repo2. commit 时自动 review
在目标项目中的.git目录下新建
.git/hooks/pre-commit
写入:
#!/usr/bin/env sh
set -eu
ai-pre-commit-review赋权
chmod +x .git/hooks/pre-commit
之后正常提交:
git add <files>
git commit -m "feat: xxx"如果 AI 没改代码,commit 继续;如果 AI 修改了代码,commit 会被阻止。你检查修改后重新暂存再提交:
git add <files>
git commit -m "feat: xxx"可选指定 agent:
ai-pre-commit-review --agent codex