aigit 0.1.8

A CLI tool to automatically generate git commit messages using OpenAI GPT-4

AI-powered Git Helper (AIGIT)

AIGIT is a command-line interface (CLI) tool that uses OpenAI to generate commit messages for your Git repositories. It checks the status of your Git repository, generates a commit message based on the changes, and commits those changes.

Installation

To install AIGIT, you need Python 3.6+ installed on your system. You can install it directly from PyPI:

pip install aigit

Or if you prefer using uv (recommended for faster installation):

uv pip install aigit

Configuration

Before using AIGIT, you need to configure your OpenAI API key. Run the following command and enter your API key when prompted:

aig --config

Usage

$ aig -h
usage: aig [-h] [--config] [-y]

AI-powered Git Helper

options:
  -h, --help  show this help message and exit
  --config    Configure API Key
  -y, --yes   Auto commit without asking for confirmation

To use AIGIT, navigate to your Git repository and run the following command:

aig

AIGIT will check the status of your Git repository, generate a commit message, and ask for your confirmation before committing the changes. If you want to auto commit without confirmation, use the -y or --yes option:

aig -y

Development

Setup Development Environment

1. Clone the repository
2. Install uv if you haven't already: pip install uv
3. Install dependencies:

   uv pip install .
   

Making Changes

The project uses pyproject.toml for dependency management and build configuration. To add new dependencies:

uv add <package-name>

To remove dependencies:

uv remove <package-name>

Building and Publishing

1. Update the version in pyproject.toml
2. Build the package:

   uv build
   

3. Publish to PyPI:

   uvx twine upload dist/*
   

Contributing

Contributions are welcome! Please feel free to submit a pull request.

License

AIGIT is open-source software licensed under the MIT license.