CommitGPT：基于 ChatGPT 的提交信息生成器

此仓库包含 CommitGPT 的源代码，这是一个帮助您使用 OpenAI ChatGPT API 创建提交信息的工具。它使用 GPT-4 架构，并为基于 Git 仓库中暂存更改生成提交信息提供简单的 CLI 界面。

功能

• 根据仓库中的暂存更改生成多个提交信息建议。
• 从不同的 ChatGPT 模型中选择。
• 自定义建议的数量、令牌和其他选项。
• 交互式选择生成的提交信息。

先决条件

要使用 CommitGPT，您需要

• OpenAI API 密钥。您可以通过访问 https://platform.openai.com/account/api-keys 创建一个。
• 在您的系统上安装 Rust 编程语言。

安装

1. 从 crates.io 安装

cargo install commitgpt

2. 创建配置文件

mkdir -p ~/.config/commitgpt
touch ~/.config/commitgpt/config.toml

3. 将您的 OpenAI API 密钥添加到配置文件中

echo 'api_key = "YOUR_OPENAI_API_KEY"' > ~/.config/commitgpt/config.toml

用法

1. 使用 git add 在 Git 仓库中暂存您的更改。
2. 运行 CommitGPT 以生成提交信息建议

commitgpt

3. 从生成的建议中选择一个提交信息，或者退出选择提示以取消。
4. 可选地，编辑提交信息并将其保存以完成提交过程。

自定义

您可以使用命令行选项自定义 CommitGPT 的行为。例如，要生成 7 个提交信息建议并将信息长度限制为 300 个令牌，运行

commitgpt -s 7 -t 300

有关更多选项，请运行 commitgpt --help。

贡献

请在 GitLab 上自由提交问题和拉取请求：https://gitlab.com/kerkmann/commitgpt

商标

我不是 OpenAi、ChatGPT 和 OpenAi 的商标或注册商标的关联、授权、认可或官方合作伙伴。这些商标是 OpenAi 在加州旧金山和其他国家的商标或注册商标。

许可

本作品根据欧盟公共许可协议（EUPL）第1.2版或随后由欧洲委员会批准的版本授权（“许可”）；
您只能在遵守许可的情况下使用此作品。
您可以在以下网址获取许可副本：

https://joinup.ec.europa.eu/software/page/eupl

除非适用法律要求或书面同意，否则在许可下分发的软件按“现状”分发，不提供任何形式的明示或暗示保证。
请参阅许可，了解许可下权限和限制的具体语言。