#commit-message #git-commit #ChatGPT #git-diff #create #creation

bin+lib gpt_commit

一个基于 git diff 让 ChatGPT 创建提交信息的工具

3 个版本

0.1.2 2023 年 4 月 29 日
0.1.1 2023 年 4 月 29 日
0.1.0 2023 年 4 月 28 日

#16 in #git-diff

每月 27 次下载

MIT 许可证

24KB
587

GPT-Commit

日语

一个基于 git diff 让 ChatGPT 创建提交信息的工具。这个工具最初是打算用于私人使用的,后来经过修改,现在可以公开使用了。

为 [conversion-commits] 创建提交信息

为什么使用它?

  • 提高效率 - 在开发过程中,如果有易于理解的提交信息记录,更改起来很方便,但想出合适的名称则是一项负担。

  • 有效性 - 避免提交日志中满是 Add(功能添加)、modifychange(更改)以及 Fix(修复错误)。

  • 学习 - 学习英语表达技巧,因为我的第一语言不是英语。

注意

在选择了实际要使用的信息后,请要求 ChatGPT 显示三个建议

GPT-4 推荐。GPT-3.5 并不准确。1/3 的提交的提交信息往往与更改不匹配。

使用适当的提交,提交信息的输出将更好。

安装

cargo insatll gpt_commit

用法

将您想要提交的更改放入暂存区,然后运行 gpt-commit。

$ gptcommit run

Requesting to ChatGPT...
Please wait a moment.
# Actual result.
# 1
# 2
# 3
Please choose [1-3]

从 API 结果中选择您认为好的提交信息编号。

如果您想提交整个工作区而不是 git diff --cached,请使用 -n(--no-cached) 选项。在这种情况下,它将执行 git commit -am "{choose message}"

gptcommit run -n
gptcommit run --no-cached

配置

以下设置:

项目 内容 选项
api_key ChatGPT 的 API 密钥 -a,--api-key
language 回复的语言(除提交信息外) -l,--language
url ChatGPT 的 API URL -u,--url
model ChatGPT 的模型 -m,--model

第一次运行时,它将创建一个配置文件,所以请输入您的 API 密钥。

$ gptcommit config
Config file is not found
Create a Config file

Enter your ChatGPT API Key
{your API_Key}

默认值在第一次设置,如有必要,请使用 cofing 命令进行设置。

gptcommit config -l Japanese
# Can be run without having to specify it
$ gptcommit config -l
Please enter language
> Spanish

许可证

MIT

作者

shunsuke6

依赖项

~7-20MB
~307K SLoC