gptcommit

一个用于借助 OpenAI 语言模型编写提交信息的 Git prepare-commit-msg 钩子。使用该工具，您可以轻松生成清晰、全面且描述性的提交信息，从而专注于编写代码。

请参阅 公告博客文章。

演示

安装

1. 推荐使用 cargo 在本地安装此工具。

cargo install --locked gptcommit

或者在 macOS 上使用 Homebrew：

brew install zurawiki/brews/gptcommit

2. 在您的 git 仓库中，运行以下命令以将 gptcommit 安装为 Git prepare-commit-msg 钩子。您需要提供 OpenAI API 密钥才能完成安装。

gptcommit install

使用方法

要使用 gptcommit，只需像平常一样运行 git commit 即可。钩子会自动使用 GPT 等大型语言模型为您生成提交信息。如果您对生成的信息不满意，可以在提交前随时进行编辑。

注意：默认情况下，gptcommit 使用最快且最具成本效益的 OpenAI 模型。请确保您的 OpenAI 账户中有足够的余额以使用该模型。

功能

gptcommit 支持从 $HOME/.config/gptcommit/config.toml 读取的多种配置选项。配置按以下顺序生效：

• 从 $HOME/.config/gptcommit/config.toml 读取的用户设置。
• 从仓库克隆目录 $GIT_ROOT/.git/gptcommit.toml 读取的设置。
• 以 GPTCOMMIT__* 开头的环境变量。

可通过 gptcommit config keys 查看所有可用的配置选项。

设置您的 OpenAI API 密钥

持久化您的 OpenAI 密钥：

gptcommit config set openai.api_key sk-...

或仅为您的本地仓库设置：

gptcommit config set --local openai.api_key sk-...

您也可以通过 GPTCOMMIT__OPENAI__API_KEY 来配置此设置。

为了与其他 OpenAI 客户端保持兼容，我们也支持 OPENAI_API_KEY 环境变量，该变量具有最高优先级。

设置自定义的 OpenAI API 基础 URL

持久化您的 OpenAI 密钥：

gptcommit config set openai.api_base https://...

或仅为您的本地仓库设置：

gptcommit config set --local openai.api_base https://...

您也可以通过 GPTCOMMIT__OPENAI__API_BASE 或其他方式来配置此设置。

为了与其他 OpenAI 客户端保持兼容，我们也支持 OPENAI_API_BASE 环境变量，该变量具有最高优先级。

尝试不同的 OpenAI 模型

gptcommit 默认使用经济高效的模型。可以通过以下方式配置为使用其他模型：

gptcommit config set openai.model your-model-name

您也可以通过 GPTCOMMIT__OPENAI__MODEL 来配置此设置。

有关公开的 OpenAI 模型列表，请参阅 OpenAI 文档。您还可以引入自己的微调模型。

设置摘要语言

gptcommit 默认使用英语。可以通过以下方式配置为使用其他语言：

gptcommit config set output.lang zh-cn

目前支持的语言如下：

locale code	language
en	英语
zh-cn	简体中文
zh-tw	繁體中文
ja	日语

允许在修改提交时重新摘要

gptcommit config set allow-amend true

代理配置支持

使用以下命令配置 OpenAI 代理：

gptcommit config set openai.proxy "my_http_proxy...."

常见问题 / 常见问答

如何减少 OpenAI 的使用费用？

在当前设计中，gptcommit 会发出 N+2 个提示，其中 N 是在 max_token_limit 限制下的已修改文件数量，其余提示分别为标题和摘要。OpenAI Completions 按“token”计费，包括发送和生成的 token 数量。每 token 的价格取决于所使用的模型。通常可以预测生成的 token 数量（因为提交信息一般不会太大），但 gptcommit 可能会发送大量的 diff 数据作为 token。

目前，我认为有两种低成本的解决方案：

• 使用 openai.model 配置选项切换到其他模型。
• 减少发送给 OpenAI 的提示和 diff 数据量。

OpenAI 的定价页面可在以下网址找到： https://openai.com/api/pricing/#faq-completions-pricing

我提交时 Git 钩子没有运行

默认情况下，Git 钩子仅在新建提交时运行。如果设置了模板或正在修改提交，则 Git 钩子默认会跳过。

由于 Git 钩子检测到用户提供了自己的模板，因此我们不会用 GPT 替换它。您可以通过确保 git config --local commit.template 为空来移除提交模板。

您可以通过上述配置允许 gptcommit 摘要修改后的提交。

在 GitHub Codespaces 中安装

您需要先安装 Rust 和 cargo 工具链。请记得配置您的 API 密钥。

curl https://sh.rustup.rs -sSf | sh
bash
cargo install --locked gptcommit

# 插入您的 OpenAI API 密钥 https://platform.openai.com/account/api-keys
gptcommit config set openai.api_key # sk-...

衍生作品

所有这些出色的项目都是基于 gptcommit 构建的。

• 一个 VSCode 扩展，您可以 在此处安装 | GitHub

遇到任何错误吗？

如果您遇到任何错误或有任何改进建议，请在仓库中提交一个问题。

许可证

本项目采用 MIT 许可证 许可。

---

详细帮助使用

$ gptcommit -h
用法：gptcommit [选项] <命令>

命令：
  install             安装 Git 钩子
  uninstall           卸载 Git 钩子
  config              读取和修改设置
  prepare-commit-msg  在 prepare-commit-msg 钩子上运行
  help                打印此消息或给定子命令的帮助信息

选项：
  -v, --verbose  启用详细日志记录
  -h, --help     打印帮助信息
  -V, --version  打印版本号

$ gptcommit install -h
安装 Git 钩子

用法：gptcommit install [选项]

选项：
  -v, --verbose  启用详细日志记录
  -h, --help     打印帮助信息
  -V, --version  打印版本号

$ gptcommit uninstall -h
卸载 Git 钩子

用法：gptcommit uninstall [选项]

选项：
  -v, --verbose  启用详细日志记录
  -h, --help     打印帮助信息
  -V, --version  打印版本号

$ gptcommit config -h
读取和修改设置

用法：gptcommit config [选项] <命令>

命令：
  keys    列出所有配置键
  list    列出所有配置值
  get     读取一个配置值
  set     设置一个配置值
  delete  清除一个配置值
  help    打印此消息或给定子命令的帮助信息

选项：
  -v, --verbose  启用详细日志记录
  -h, --help     打印帮助信息
  -V, --version  打印版本号

$ gptcommit config keys
allow_amend
file_ignore
model_provider
openai.api_base
openai.api_key
openai.model
openai.proxy
openai.retries
output.conventional_commit
output.conventional_commit_prefix_format
output.lang
output.show_per_file_summary
prompt.commit_summary
prompt.commit_title
prompt.conventional_commit_prefix
prompt.file_diff
prompt.translation

gptcommit 快速上手指南

gptcommit 是一个基于 OpenAI 大模型的 Git prepare-commit-msg 钩子工具。它能自动分析你的代码变更，生成清晰、全面的提交信息，让你专注于代码编写。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows (需配置相应环境)。
• 前置依赖：
  • Git：已安装并配置好。
  • Rust (推荐)：用于通过 cargo 安装（若使用 Homebrew 则无需手动安装 Rust）。
  • OpenAI API Key：你需要拥有一个有效的 OpenAI 账户并获取 API Key。
  • 网络环境：由于需要连接 OpenAI 服务，请确保网络通畅。国内用户建议配置代理或在配置中设置 openai.proxy。

安装步骤

你可以选择以下任意一种方式进行安装：

方式一：使用 Cargo 安装（推荐）

cargo install --locked gptcommit

方式二：使用 Homebrew 安装（仅限 macOS）

brew install zurawiki/brews/gptcommit

配置 Git 钩子与 API Key

安装完成后，进入你的 Git 仓库目录，运行以下命令将 gptcommit 注册为 Git 钩子。首次运行时需输入你的 OpenAI API Key：

gptcommit install

提示：你也可以先单独配置 API Key，再执行安装：

gptcommit config set openai.api_key sk-...
gptcommit install

若需使用国内代理，可配置：

gptcommit config set openai.proxy "http://your-proxy-address:port"

基本使用

配置完成后，使用流程与普通 Git 提交完全一致。

1. 修改代码并进行暂存：

   git add .
   

2. 执行提交命令：

   git commit
   

3. 自动生成与确认：

   • gptcommit 会自动拦截提交过程，调用 AI 分析差异并生成提交信息。
   • 编辑器会打开预填好的提交信息供你预览。
   • 如果满意，直接保存退出即可完成提交；如果不满意，你可以手动编辑修改后再保存。

进阶：切换为中文提交信息

默认情况下生成英文提交信息。若希望生成简体中文的提交信息，请运行：

gptcommit config set output.lang zh-cn

此后执行 git commit 即可自动生成中文提交说明。