git-cai-cli 0.1.1.dev0

Use LLM to create git commits

cai

cai is a Git extension written in Python that automates commit message creation. It allows you to run git cai to automatically generate a commit message based on changes and new additions in your repository.

cai leverages a large language model (LLM) to generate meaningful and context-aware commit messages. Currently, it supports the OpenAI and Gemini API for generating commit messages.

Table of Contents

• About
• Prerequisites
• Features
• Installation
• Usage
• License

About

cai is designed to simplify your Git workflow by automatically generating commit messages using an LLM. No more struggling to summarize changes — git cai does it for you.

Currently, the only supported backend are the OpenAI and Gemini API, but additional LLM integrations may be added in the future.

Prerequisites

• Python 3.10 or higher
• Pipx or Pip if installed in a virtual environment
• API key, currently supported
  • OpenAI
  • Gemini

Features

• Automatically detects added, modified, and deleted files
• Generates meaningful commit messages using an LLM
• Seamless integration with Git as a plugin/extension
• Written in Python for easy customization

Installation

Install by

pipx install git-cai-cli

Afterwards set cai to PATH by

pipx ensurepath

Restart your shell by executing bash or zsh or whatever else is your used shell.

Usage

Once installed, you can use cai like a normal Git command:

git cai

cai automatically creates a configuration file at: ~/.config/cai/token.yml This file stores your OpenAI API key, which is used every time you run git cai. Open ~/.config/cai/token.yml and store your token from OpenAI. If a cai_config.yml file exists in the root of your repository, cai will use the settings defined there. Otherwise, it falls back to default settings, which are automatically created in the same directory as token.yml if they don’t already exist. Currently, the only configurable options are:

• LLM model
• Temperature

cai uses Git’s diff output as input for generating commit messages.
To exclude specific files or directories from being included in the generated commit message, create a .caiignore file in the root of your repository. This file works like a .gitignore.

• Files listed in .gitignore are always excluded.
• .caiignore is only needed for files that are tracked by Git but should not be included in the commit message.

License

This project is licensed under the MIT License.