gptcommit 使用教程

gptcommit 使用教程

gptcommit A git prepare-commit-msg hook for authoring commit messages with GPT-3. 项目地址: https://gitcode.com/gh_mirrors/gp/gptcommit

1. 项目介绍

gptcommit 是一个 Git 提交消息准备钩子，用于生成清晰、全面和描述性的提交消息，让你可以专注于编写代码。该工具通过集成大型语言模型（如 GPT）自动生成提交消息，提高开发效率。

2. 项目快速启动

安装

首先，你需要安装 gptcommit。推荐使用 cargo 进行安装：

cargo install --locked gptcommit

在 macOS 上，你也可以使用 homebrew 进行安装：

brew install zurawiki/brews/gptcommit

配置

安装完成后，在你的 Git 仓库中运行以下命令来安装 gptcommit 作为 Git 提交消息准备钩子。你需要提供一个 OpenAI API 密钥才能完成安装：

gptcommit install

使用

正常使用 git commit 命令时，钩子会自动为你生成提交消息。如果不满意生成的消息，你可以在提交前编辑它。

注意：默认情况下，gptcommit 使用 GPT-3 模型。请确保你的 OpenAI 账户有足够的积分来使用它。

3. 应用案例和最佳实践

减少 OpenAI 使用费用

当前设计中，gptcommit 会发出 N+2 个提示，其中 N 是修改文件的数量，每个文件都有 diff 并且在最大 token 限制之下。其他提示是标题和摘要。

OpenAI 的补全按“tokens”计费，包括发送和生成的 tokens。具体价格取决于所使用的模型。生成的 tokens 数量通常是可预测的（因为提交消息通常只有这么大），但 gptcommit 可能会向 OpenAI 发送大量的 tokens，即 diff 数据。

有两种方法可以减少成本：

• 切换到不同的模型，使用 openai.model 配置选项。
• 减少发送给 OpenAI 的提示和 diff 数据的大小。

允许重写提交消息

如果你在修正提交时想要重新生成提交消息，可以使用以下配置：

gptcommit config set allow-amend true

4. 典型生态项目

目前尚无明确的典型生态项目列出，但 gptcommit 可以为各种需要生成提交消息的 Git 项目提供支持。例如，它已经被集成到一些 VSCode 扩展中，以提高开发者的工作效率。如果你有更多关于如何使用 gptcommit 的案例，欢迎分享。

gptcommit A git prepare-commit-msg hook for authoring commit messages with GPT-3. 项目地址: https://gitcode.com/gh_mirrors/gp/gptcommit