Gai - AI for Git

2024 Nov 03 See all posts


Gai - AI for Git

Gai is an AI-Powered Automation Tool for Git 🚀

command-line application that automates git commit messages and merge requests using AI.

Github Github

PyPI PyPI

Demo

✨ Features

📦 Installation

Install gai-tool via pip:

pip install gai-tool

🚀 Getting Started

  1. Navigate to your git repository:

    cd /path/to/your/git/repo
  2. Set API Tokens as Environment Variables:

    # Ensure you have your AI interface and GitHub/GitLab API tokens set:
    export GROQ_API_KEY='your_groq_api_key'             # If you want to use Groq's API
    export HUGGINGFACE_API_TOKEN='your_hf_api_token'    # If you want to use Hugging Face's API
    export GITHUB_TOKEN='your_github_token'             # If using GitHub
    export GITLAB_TOKEN='your_gitlab_token'             # If using GitLab
  3. Start Using gai-tool:

    # Generate an AI-powered commit message:
    gai commit -a

⚙️ Configuration

Configuration file is located at ~/.config/gai/config.yaml. Customize settings like the AI interface, temperature, and target branch.

Example configuration:

interface: huggingface
temperature: 0.7
target_branch: master

📖 Usage

gai-tool provides two main commands: commit and merge.

📝 Commit Messages

Generate an commit message:

gai commit

Options:

Example:

# Simply
gai commit -a
# Or
gai commit -a -t 0.5 -i huggingface

🔀 Merge Requests

Create a merge request:

gai merge

Options:

Example:

# Simply
gai merge -p
# Or
gai merge origin -p -tb develop -t 0.8 -i groq

🛠 Build Instructions

Build gai-tool from source:

  1. Clone the Repository:

    git clone https://github.com/Danielratmiroff/gai.git
  2. Navigate to the Project Directory:

    cd gai
  3. Create a Virtual Environment (Optional but Recommended):

    python -m venv venv
    source venv/bin/activate  # On Windows use venv\Scripts\activate
  4. Install Build Tools and Dependencies:

    pip install build
    pip install -r requirements.txt
  5. Build the Package:

    python -m build

    This will generate distribution files in the dist/ directory.

  6. Install the Built Package:

    pip install dist/gai_tool-0.1.0-py3-none-any.whl