ai-commit

项目介绍：ai-commit

项目概述

ai-commit 是一个利用人工智能自动生成约定式 Git 提交信息的开源工具。通过利用先进的 AI 技术，开发者在进行代码提交时，可以轻松生成符合规范的提交信息，从而提高开发效率，确保项目中的变更记录清晰可查。

支持平台

ai-commit 支持多种 AI 接口，包括但不限于：

• Bito CLI
• ERNIE-Bot 和 ERNIE-Bot-turbo
• GitHub Copilot CLI 和 GitHub Models CLI
• Moonshot
• OpenAI Chat 和 OpenAI

这些平台的 AI 技术为 ai-commit 提供了智能支持，确保生成的提交信息准确且符合规定。

系统要求

ai-commit 需要 PHP 版本 7.3 或更高版本。

安装方法

用户可以通过以下两种方式安装 ai-commit：

下载可执行文件

使用 curl 下载 ai-commit 文件，并赋予执行权限：

curl 'https://raw.githubusercontent.com/guanguans/ai-commit/main/builds/ai-commit' -o ai-commit -#
chmod +x ai-commit

通过 Composer 安装

用户可以通过 Composer 命令安装：

• 全局安装：

  composer global require guanguans/ai-commit --dev -v

• 本地安装：

  composer require guanguans/ai-commit --dev -v

使用说明

快速开始

用户可以通过以下命令快速配置和使用 ai-commit：

./ai-commit config set generators.openai_chat.api_key sk-... --global # 配置 OpenAI API 密钥
./ai-commit commit # 使用默认生成器生成并提交信息

用户还可以指定不同的生成器来生成提交信息，例如：

./ai-commit commit --generator=github_copilot_cli

列出命令和配置信息

使用 list 和 config 命令查看可用命令和配置选项：

./ai-commit list
./ai-commit config list

自我更新和帮助

用户可以通过 self-update 命令更新到最新版本，并使用 help 查看帮助信息：

./ai-commit self-update
./ai-commit commit --help

测试

安装完成后，开发者可以通过以下命令运行项目测试：

composer test

变更日志

请查看项目中的 CHANGELOG 文件，以了解最近的更改。

贡献指南

详细的贡献指南请参阅项目的 CONTRIBUTING 文件。

安全漏洞

关于如何报告安全漏洞的信息，请参阅我们的安全政策。

作者和鸣谢

ai-commit 由 guanguans 开发，感谢所有的贡献者。

许可证

本项目采用 MIT 许可证，更详细的信息请查看 LICENSE 文件。