#commit-message #openai #staged #diff #git-commit #generate #command-line-tool

应用 gcm-ai

GCM-AI 是一个基于 OpenAI 使用已暂存更改的差异生成提交消息的命令行工具。

2 个版本

0.1.7 2023 年 3 月 29 日
0.1.5 2023 年 2 月 17 日

#9#staged

MIT 许可证

19KB
438

GCM-AI

Rust

gcm-ai

GCM-AI 是一个基于 OpenAI 使用已暂存更改的差异来生成提交消息的命令行工具。

本应用受 aicommits 启发,进行了一些调整,并使用 Rust 编写。

安装

要安装 GCM-AI,您需要在您的系统上安装 Rust。您可以按照 此处 的说明安装 Rust。

安装 Rust 后,您可以通过运行以下命令来安装 GCM-AI:

cargo install gcm-ai

使用方法

要为已暂存更改生成提交消息,只需运行以下命令

gcm-ai

这将使用 OpenAI 的 GPT-3 语言模型生成提交消息,并将其打印到控制台。然后,您可以将其复制并粘贴到您的 git 提交中。

配置

GCM-AI 使用 OpenAI API 来生成提交消息。要使用 OpenAI API,您需要一个 API 密钥。您可以通过在 此处 注册 OpenAI 来获取 API 密钥。

请注意,OpenAI 目前处于测试版,API 不是免费的。但到目前为止,当您注册时,您将获得 18 美元的免费信用额度,用于在 API 上使用,这应该足以生成足够的提交消息,因为生成的提交消息非常便宜。

一旦您有了 API 密钥,您可以通过运行以下命令配置 GCM-AI 使用它

gcm-ai --config

这将提示您输入您的 OpenAI API 密钥。一旦您输入您的 API 密钥,它将被保存到您主目录中的一个 .toml 配置文件中。

贡献

欢迎贡献!如果您想为 GCM-AI 做出贡献,请提交一个拉取请求。

许可证

GCM-AI 使用 MIT 许可证。有关更多信息,请参阅 LICENSE 文件。

依赖关系

~7–22MB
~299K SLoC