AI Commit

AI Commit 是一个使用 AI 生成提交消息的命令行工具。它支持多个 AI 提供商和模型，以帮助您为 Git 仓库创建有意义的、一致的提交消息。

功能

• 根据 git 差分生成提交消息
• 支持多个 AI 提供商（OpenAI 和 OpenRouter）
• 可定制的 AI 模型
• 列出每个提供商可用的模型

安装

您可以从 GitHub 上最新版本 最新发布 下载适用于您的系统的预构建二进制文件来安装 AI Commit。

1. 下载适合您的系统的相应存档

   • 对于 macOS (Intel)：ai-commit-x86_64-apple-darwin.tar.gz
   • 对于 macOS (Apple Silicon)：ai-commit-aarch64-apple-darwin.tar.gz
   • 对于 Linux (x86_64)：ai-commit-x86_64-unknown-linux-gnu.tar.gz
   • 对于 Linux (ARM64)：ai-commit-aarch64-unknown-linux-gnu.tar.gz
   • 对于 Windows：ai-commit-x86_64-pc-windows-msvc.zip

2. 解压存档

   • 对于 .tar.gz 文件：tar xzf ai-commit-<版本>.tar.gz
   • 对于 .zip 文件：使用您首选的工具解压

3. 将 ai-commit 二进制文件移动到您的 PATH 目录中，例如

   sudo mv ai-commit /usr/local/bin/
   

或者，如果您喜欢从源代码构建，请确保您的系统上已安装Rust和Cargo。然后，克隆此存储库并构建项目

git clone https://github.com/EgorHenek/ai-commit.git
cd ai-commit
cargo build --release

编译的二进制文件将在 target/release/ai-commit 中可用。

用法

要使用AI Commit，您需要设置您想使用的AI提供商的API密钥。您可以通过设置环境变量来完成此操作

• 对于OpenAI: OPENAI_API_KEY
• 对于OpenRouter: OPENROUTER_API_KEY

基本用法

git diff | ai-commit

这将使用默认提供商（OpenAI）和模型，根据当前的git diff生成提交信息。

指定提供商和模型

git diff | ai-commit --provider openrouter --model gpt-3.5-turbo

列出可用模型

ai-commit --provider openai --list-models

完整的命令行选项

ai-commit --help

配置

您可以使用环境变量设置AI模型和提供商的默认值

• AI_MODEL: 设置默认的AI模型
• OPENAI_API_KEY: 设置OpenAI的API密钥
• OPENROUTER_API_KEY: 设置OpenRouter的API密钥

贡献

欢迎贡献！请随时提交Pull Request。

许可

此项目受MIT许可证许可 - 有关详细信息，请参阅LICENSE文件。