
gptcommit
让 AI 帮你写 Git 提交信息,告别凑字数。
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 2411
技术标签
使用教程
环境要求
- 已安装 Rust 与 cargo 工具链(macOS 也可用 Homebrew 安装)
- 一个可用的 Git 仓库,用于安装 prepare-commit-msg 钩子
- OpenAI API Key,且账户内有足够额度
- 网络受限时需准备可用的 HTTP 代理
安装与启动步骤
-
1安装 gptcommit
README 推荐用 cargo 安装并锁定依赖版本;macOS 用户也可改用 Homebrew 安装。
cargo install --locked gptcommit -
2安装 Git 钩子
在目标 Git 仓库目录中执行,把 gptcommit 注册为 prepare-commit-msg 钩子,过程中需提供 OpenAI API Key。
gptcommit install -
3提交并验证
照常执行 git commit,钩子会自动分析暂存区 diff 并生成提交信息草稿,不满意可在提交前手动编辑。
git commit -
4调整配置
先列出可用配置键,再用 config set 修改;例如网络受限时配置 OpenAI 代理。
gptcommit config keys gptcommit config set openai.proxy "http://127.0.0.1:7890"
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
openai.api_key | 是 | OpenAI API 密钥,安装钩子时即需要提供 | sk-xxxxxxxx |
openai.model | 否 | 指定使用的 OpenAI 模型,可用于降低调用费用 | gpt-3.5-turbo |
openai.proxy | 否 | 为 OpenAI 请求配置 HTTP 代理 | http://127.0.0.1:7890 |
openai.api_base | 否 | 自定义 OpenAI 接口地址 | https://api.openai.com/v1 |
output.conventional_commit | 否 | 控制是否输出规范化的提交信息格式 | true |
output.lang | 否 | 设置生成提交信息的语言 | zh |
如何确认成功
在仓库执行 git commit,提交信息框中出现自动生成的提交信息草稿即表示钩子生效。
常见问题
Q:提交时钩子没有运行怎么办?
A:钩子默认只对新提交生效;若设置了 commit.template 或正在 amend 提交会自动跳过,可执行 git config --local commit.template 确保其为空。
Q:如何降低 OpenAI 费用?
A:gptcommit 会产生 N+2 个请求,可通过 openai.model 换成更便宜的模型,或减少提示词与 diff 数据量来降低消耗。
Q:提交时报额度不足?
A:默认使用最快最省钱的 OpenAI 模型,请确认 OpenAI 账户中有足够余额。
Q:macOS 上可以用别的安装方式吗?
A:可以,使用 Homebrew:brew install zurawiki/brews/gptcommit。
Q:在 GitHub Codespaces 中怎么装?
A:先安装 Rust 工具链:curl https://sh.rustup.rs -sSf | sh,重开 bash 后再执行 cargo install --locked gptcommit,并配置好 API Key。
注意事项
- 配置文件读取自 $HOME/.config/gptcommit/config.toml,也可用 gptcommit config 系列命令读写。
- 安装钩子时必须提供 OpenAI API Key,否则无法完成安装。
- 自动生成的提交信息会作为草稿填入,可在提交前自由编辑。
- 如不再需要,可在仓库中执行 gptcommit uninstall 卸载钩子。
核心亮点
- 基于真实代码 diff 生成,提交信息与改动高度相关
- 支持自定义提示词和模型,适配不同团队的提交规范
- Rust 实现,安装为单一二进制,性能好且易于分发
不足之处
- 依赖外部 LLM API,需要网络和 API 密钥,存在调用成本
- 生成质量受模型能力影响,复杂改动可能需要人工修改
- 文档/社区待观察
适用场景
- 个人开发者快速生成规范提交信息
- 团队统一提交信息格式,提升代码审查效率
- 开源项目维护者批量处理 Pull Request 提交
替代项目
commitgpt、aicommits、gpt-commit
同类项目推荐
Awesome-Repo-Level-Code-Generati···
开源
一键速览仓库级代码生成前沿论文,紧跟AI写代码新趋势。
Must-read papers on Repository-level Code Generation & Issue Resolution
kota
开源
用 Rust 打造的轻量 AI 编码代理,插件化扩展你的开发流程。
A lightweight, hackable agent harness written in Rust.
jupyter-studio
开源
让 Jupyter 拥有 Cursor 级 AI 能力,一键修复报错
The AI-native JupyterLab — open-source Cursor for notebooks. Cmd+K inline edit, mul···
claudian
开源
在 Obsidian 笔记库里直接召唤 AI 代理干活
An Obsidian plugin that embeds Claude Code, Codex and other agents as an AI collabor···
codra
开源
在 Cloudflare 边缘自动审查 PR,提升代码质量
Self-hosted AI code review for GitHub pull requests.
opencommit
开源
1秒生成规范提交信息,告别憋提交词
top #1 and most feature rich GPT wrapper for git — generate commit messages with an···
zed-globalization
开源
装完即用的 Zed 中文版,AI 自动跟进官方更新
Zed 编辑器汉化版 / 中文版 / 多语言版 — AI 驱动全自动翻译构建,支持简繁中文/日语/韩语···
awesome-claude-code
开源
一份清单收齐 Claude Code 周边工具,省去到处翻找
A curated list of awesome tools, IDE integrations, frameworks, and other resources f···
fast-request
开源
IDE 里直接调接口,省去手写请求和切工具
IntelliJ IDEA plugin Fast Request