commitgpt

使用 ChatGPT 自动生成提交信息。

如何使用？

npx commitgpt

获取 OpenAI API 密钥

https://platform.openai.com/account/api-keys

配置（可选）

你可以在项目根目录下创建 .commitgpt.json 和/或 .commitgpt-template 配置文件。

.commitgpt.json 文件

默认内容：

{
  "model": "text-davinci-003",
  "temperature": 0.5,
  "maxTokens": 2048,
}

此文件可用于更改 OpenAI 模型及其他参数。

.commitgpt-template 文件

默认内容：

根据以下差异建议 10 条提交信息：
{{diff}}
提交信息应：
 - 遵循规范化的提交格式
 - 使用 <type>[scope]: <description> 的格式

示例：
 - fix(authentication): 添加密码正则表达式模式
 - feat(storage): 添加新的测试用例

此文件可用于修改用于生成提示请求的模板。你可以根据自己的需求调整模板。

工作原理

• 执行 git diff --cached
• 将差异内容发送给 ChatGPT，请其建议提交信息
• 向用户展示建议

致谢

部分代码和方法受到以下优秀项目的启发：

• https://github.com/acheong08/ChatGPT
• https://github.com/transitive-bullshit/chatgpt-api
• https://github.com/wong2/chat-gpt-google-extension

---

需要 API 文档吗？请查看 Redocly。

commitgpt 快速上手指南

commitgpt 是一个基于 ChatGPT 的命令行工具，能够自动分析你的代码变更（diff）并生成符合规范的 Git 提交信息。

环境准备

在开始之前，请确保满足以下条件：

• Node.js 环境：已安装 Node.js（推荐 v14 或更高版本），因为该工具通过 npx 运行。
• OpenAI API Key：你需要拥有一个有效的 OpenAI API 密钥。
  • 获取地址：https://platform.openai.com/account/api-keys
  • 注意：由于网络原因，国内开发者可能需要配置代理或使用镜像服务才能正常调用 OpenAI 接口。

安装步骤

commitgpt 无需全局安装，可直接通过 npx 按需运行。

确保你的终端可以访问外网（或已配置好代理），然后在项目根目录下执行：

npx commitgpt

首次运行时，工具会提示你输入 OpenAI API Key，或者你可以将其设置为环境变量 OPENAI_API_KEY。

基本使用

1. 生成提交信息

暂存你想要提交的代码更改，然后直接运行命令：

git add .
npx commitgpt

工具将自动执行 git diff --cached，将差异发送给 ChatGPT，并在终端展示生成的提交建议供你选择。

2. 自定义配置（可选）

你可以在项目根目录创建配置文件来调整模型参数或提示词模板。

调整模型参数 (.commitgpt.json)

创建 .commitgpt.json 文件以修改使用的模型、温度等参数：

{
  "model": "text-davinci-003",
  "temperature": 0.5,
  "maxTokens": 2048
}

自定义提示词模板 (.commitgpt-template)

创建 .commitgpt-template 文件以定制生成逻辑（例如强制遵循 Conventional Commits 规范）：

suggest 10 commit messages based on the following diff:
{{diff}}
commit messages should:
 - follow conventional commits
 - message format should be: <type>[scope]: <description>

examples:
 - fix(authentication): add password regex pattern
 - feat(storage): add new test cases