ai-commit

AI-Commit: Revolutionizing Git Commit Messages with AI

AI-Commit is an innovative tool designed to automatically generate conventional git commit messages using artificial intelligence. This project aims to streamline and enhance the process of creating concise and informative commit messages that are essential for effective version control and collaboration in software development.

Key Features

• Automated Message Generation: AI-Commit utilizes advanced AI models to automatically produce contextual and conventional commit messages, saving developers both time and effort.
• Support for Multiple AI Models: The project integrates support for several AI platforms, including Bito CLI, ERNIE-Bot, ERNIE-Bot-turbo, GitHub Copilot CLI, Moonshot, and OpenAI, offering flexibility and adaptability.
• Language and Format: The tool is equipped to generate messages in multiple languages, ensuring it caters to a global audience.

Requirements

AI-Commit requires PHP version 7.3 or higher to function. This makes it accessible to a wide range of systems where PHP is deployed.

Installation Instructions

There are two primary methods to install AI-Commit:

1. Direct Download:
   • Use the command curl to download the AI-Commit file and grant execute permissions with chmod +x ai-commit.
2. Composer Installation:
   • Via Composer for global access: composer global require guanguans/ai-commit --dev -v.
   • Locally within a project: composer require guanguans/ai-commit --dev -v.

Usage Overview

AI-Commit is highly configurable, allowing users to set various parameters and select AI models for message generation. Here's a quick guide to getting started:

• Configure the tool by setting API keys and selecting preferred AI generators.
• Generate commit messages by running the ./ai-commit commit command, which prompts users to confirm and execute the message generation and commit process.

The tool provides options to customize commit type and further refine the commit message to suit various project needs.

Commands and Configuration

Apart from the primary commit command, AI-Commit offers several commands for configuration and management:

• List Commands: Displays all available commands.
• Operate Config: Commands allow setting, getting, unsetting, and editing configuration options.

There is also a self-update feature ensuring users can easily update the tool to the latest version.

Testing and Contributions

• Testing: Users and developers can run composer test to execute tests and verify functionality.
• Contribution: Contributions are welcomed and encouraged. Contributors can refer to the provided guidelines to get involved.

Security and Credits

AI-Commit takes security seriously, offering a security policy for reporting any vulnerabilities. The project credits guanguans and all contributors for their efforts in developing this tool.

License

AI-Commit is open-source, distributed under the MIT License, allowing users to freely use, modify, and distribute the software with minimal restrictions.

AI-Commit stands out as a powerful tool for developers looking to automate and improve the process of creating git commit messages, enhancing workflow efficiency in software projects.