CommitBuddy 🤖

Your AI-Powered Git Commit Assistant 🚀

📖 Overview

CommitBuddy is an intelligent command-line tool that revolutionizes your Git workflow by generating semantic commit messages using AI. Powered by the Ollama CLI, it provides a fun, interactive, and step-by-step process to craft clear, conventional commit messages.

✨ Key Features

🎯 Smart Commit Generation

• AI-powered semantic commit message generation
• Conventional commit format compliance
• Context-aware suggestions based on your changes

🔄 Interactive Workflow

• Step-by-Step Process: Guided commit creation with progress indicators
• Multiple Options:
  • ✅ Accept & commit changes
  • 🔄 Regenerate commit message
  • ❌ Abort process
• Real-time Feedback: Clear status updates and error messages

🔍 Built-in Diagnostics

• Configuration verification
• Git installation check
• Ollama server connectivity test
• Model availability confirmation

🚀 Getting Started

Prerequisites

• Python 3.6 or higher
• Git (initialized repository)
• Ollama installed and running

Installation

For Users

pip install commit-buddy

For Developers

git clone https://github.com/atom2ueki/commitbuddy
cd commitbuddy
pip install -e .

⚙️ Configuration

CommitBuddy uses a .commit-buddy.yml configuration file with the following search priority:

1. Current project directory
2. Home directory (~/.commit-buddy.yml)

Sample Configuration

# Model settings
model: qwen:14b              # Ollama model selection
ollamaIp: localhost:11434    # Ollama server address

🎮 Usage Guide

Generate Commit Message

commitbuddy generate

The process follows these steps:

1. 🔍 Loading configuration
2. 📄 Retrieving staged changes
3. 🤖 Generating AI commit message
4. 🎯 Presenting options
5. 🚀 Committing changes (if accepted)

Interactive Options

What would you like to do?
👉 [Y] Accept & commit
👉 [R] Regenerate message
👉 [N] Abort
Your choice (Y/R/N):

Run Diagnostics

commitbuddy doctor

Checks performed:

• ✅ Configuration validation
• ✅ Git installation verification
• ✅ Ollama server connection
• ✅ Model availability

🤝 Contributing

We welcome contributions! Whether it's bug fixes, feature additions, or documentation improvements, please feel free to:

1. Fork the repository
2. Create your feature branch
3. Submit a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Report Bug · Request Feature