GitAI

GitAI is a command-line tool powered by AI that makes your Git workflow smoother and easier. It helps you create commit messages, understand changes, and manage your repository—all without needing an API key.

Features ✨

• Smart Commit Messages: Automatically generates clear and standard commit messages based on your staged changes.
• Git History Insights: Easily explains the changes in commits, branches, or your current work.
• Zero Configuration: Instantly usable without setup or API keys—uses Phind AI by default.
• Flexible: Fits smoothly into any Git workflow and supports multiple AI providers.

Getting Started 🔅

Prerequisites

Before you begin, ensure you have git installed on your system

Installation

Using Cargo

[!IMPORTANT] cargo is a package manager for rust, and is installed automatically when you install rust. See installation guide

cargo install gitai

Usage 🔅

Generate Commit Messages

Create meaningful commit messages for your staged changes:

# Basic usage - generates a commit message based on staged changes
gitai generate
# Output: "feat(button.tsx): Update button color to blue"

Explain Changes

Understand what changed and why:

# Explain current changes in your working directory
gitai explain --diff                  # All changes
gitai explain --diff --staged         # Only staged changes

# Explain specific commits
gitai explain HEAD                    # Latest commit
gitai explain abc123f                 # Specific commit

AI Providers 🔅

Configure your preferred AI provider:

# Using CLI arguments
gitai -p openai -k "your-api-key" -m "gpt-4o" generate

# Using environment variables
export GITAI_PROVIDER="openai"
export GITAI_API_KEY="your-api-key"
export GITAI_MODEL="gpt-4o"