aicommits-rs

A CLI that writes your git commit messages for you with AI. This project was inspired by AI Commits and has been ported to Rust.

此仓库中的所有提交消息都是使用此工具生成的。

安装

使用 Cargo

1. 安装 Rust 和 Cargo。然后运行

cargo install aicommits-rs

2. 从 OpenAI 获取您的 API 密钥

   注意：如果您还没有，您需要创建一个帐户并设置计费。

3. 将您的 API 密钥设置为环境变量

export OPENAI_API_KEY=<your_api_key>

Homebrew（仅限 Mac）

运行以下命令安装 CLI 工具的最新版本

brew install EtaCassiopeia/tap/aicommits-rs

Linux

运行以下命令安装 CLI 工具的最新版本

curl -L //TBD

用法

aicommits-rs

工作原理

此 CLI 工具使用 git diff 获取所有最新的代码更改，然后将其发送到 OpenAI 的 GPT-3 以生成返回的提交消息。如果返回的提交消息不满意，您可以再次运行命令以生成新的提交消息，否则您可以使用返回的提交消息提交您的更改。

注意：当对文件的更改数量太大，OpenAI API 无法处理时，可能会发生错误。为了避免此错误，尝试减少暂存更改的数量或编写自己的提交消息。

注意：此工具仍在开发中，并不能保证按预期工作。