Git AI

Git AI 将 ChatGPT 与 git 钩子无缝集成，根据您已准备的文件自动生成提交信息。无需消息即可提交更改；Git AI 会完成剩余工作，为您创建反映更改精髓的详细提交信息。

主要功能

• 智能集成：利用 OpenAI 强大的 Assistant API，精心定制以将 git 差分转换为有洞察力的提交信息。
• 上下文学习：此功能为每个项目维护一个专用线程，使助手能够随着时间的推移建立上下文，从而提高性能和消息的相关性。
• 本地优化：在您的机器上托管专用的助手实例，从所有项目学习，以提升开发环境中所有提交信息的质量。

快速开始

# Install Git AI
cargo install git-ai

# Set your OpenAI API key
git-ai config set openai-api-key <your key>

# Install the Git AI hook in your repo
git-ai hook install

# Make your changes, stage them, and commit without a message
git commit --all --no-edit

入门

先决条件

• 您的机器上已安装 Rust 和 Cargo。

安装选项

通过 Crates.io

cargo install git-ai
git-ai config set openai-api-key <api-key>
git-ai hook install

从源代码

git clone https://github.com/oleander/git-ai
cd git-ai
cargo install --path .

使用指南

设置

• 按照安装说明将 Git AI 准备就绪。
• 使用 git-ai hook install 在您的存储库中初始化 Git AI。
• 使用 git-ai config set openai-api-key <api-key> 设置您的 OpenAI API 密钥。

高级配置

使用以下命令自定义 Git AI 的行为

• git-ai config set max-commit-length <length> (默认值：72)：设置提交消息的最大长度。
• git-ai config set max-tokens <tokens> (默认值：512)：设置助手的最大令牌数。
• git-ai config set model <model> (默认值： "gpt-3.5-turbo")：设置要使用的OpenAI模型。
• git-ai config set openai-api-key <api-key>：设置您的OpenAI API密钥。

贡献

欢迎您的反馈和贡献！加入我们的社区，通过提交问题、提出建议或贡献代码来帮助改进 Git AI。有关详细信息，请参阅我们的贡献指南。

测试

运行 cargo test 执行测试套件并确保一切按预期运行。

许可协议

Git AI 骄傲地开源，采用MIT许可协议。有关详细信息，请参阅LICENSE。