AI Commit (aicmt)

AI Commit (aicmt) is an AI-driven command-line tool designed to revolutionize the way Git commits are made by automating the creation of intelligent and meaningful commit messages. By analyzing code changes, aicmt not only generates messages but also organizes changes into structured commits, following Git best practices.

Key Features

• Intelligent Change Splitting: Aicmt evaluates your code adjustments and divides them into logical, focused commits, adhering to best practices.
• Flexible Control: Users can opt for AI-determined commits or manually set the desired number of commits.
• Enhanced Focus on Development: Developers can concentrate on coding without worrying about commit organization. Aicmt takes care of creating atomic commits.

Quick Start Guide

1. Configuration

   • Create a configuration file .aicmtrc in your home directory based on the template provided.

   cp .aicmtrc.template ~/.aicmtrc
   

   • Alternatively, create .aicmtrc in your current directory to override the global settings.

   cd /path/to/git/repo
   touch .aicmtrc
   

   • Include your OpenAI API credentials in the configuration file.

2. Usage

   • Navigate into your Git repository directory and execute the aicmt command to effortlessly generate commit messages.

   $ aicmt -h
   usage: aicmt [-h] [-v] [-n N]
   
   <<< AICMT (AI Commit) - AI-powered Git commit assistant >>>
   
   options:
     -h, --help           show this help message and exit
     -v, --version        show program's version number and exit
     -n, --num-commits N  Number of commits to generate (default: AI decides)
   

Development and Contributing

• To contribute, start by cloning the repository and installing the necessary dependencies.

  git clone https://github.com/versun/aicmt.git
  cd aicmt
  pip install -e "[dev]"
  

• Encounter issues? While the project is powered by AI-generated code, users are encouraged to initially seek AI assistance to troubleshoot problems. Persisting issues can be submitted as an issue in the project repository.
• Contributions are warmly welcomed, with a request to submit an issue before a pull request to prevent duplicate efforts.

Acknowledgments

Gratitude is extended to sponsors who support this open-source endeavor. Contributions make ongoing development possible. Interested in supporting? Consider sponsoring through GitHub or other platforms like 爱发电.

• View Sponsor Details and become part of this journey.