autocommitt 0.1.6

A CLI tool for generating editable commit messages with local AI models

A lightweight CLI tool that automatically generates meaningful commit messages using small, efficient AI models locally. AutoCommitt leverages Ollama's Llama model (3B parameters) to create concise, context-aware commit messages while keeping resource usage minimal.

✨ Features

• Local AI-Powered: Generates commit messages using a small 3B parameter model
• Flexible Editing: Review and edit generated messages before committing
• Privacy-First: All operations performed locally, ensuring data privacy
• Git Integration: Seamlessly works with your existing Git workflow

🚀 Quick Start

Prerequisites

• Python 3.8 or higher
• Git installed and configured
• Ollama installed locally
• Minimum 8GB RAM

Installation

pip install autocommitt

Usage

Just three simple steps:

1. Stage your files:

   git add your_file_name
   

2. Generate and edit commit message:

   ac
   

   This will generate a commit message based on your changes. Edit it if needed.

3. Press Enter to commit your changes.

That's it! 🎉

🔜 Coming Soon

• Git hooks integration: Compatible with all pre-commit hooks
• Cross-Platform: Enhanced support for Windows, macOS, and Linux
• Custom Templates: Support for user-defined commit message templates
• Interactive Mode: Enhanced CLI interface for better user experience

🐛 Need Help?

• Found a bug? Open an issue
• Have questions? Check our discussions
• Want to contribute? Check out our Contributing Guidelines

📊 Project Status

• Basic commit message generation
• Local AI model integration (3B parameters)
• Python package release
• Cross-platform testing
• Interactive mode
• Custom template support

📄 License

Licensed under the Apache License 2.0 - see the LICENSE file for details.

---

👩‍💻 For Developers

Interested in contributing to AutoCommitt? We'd love your help! Check out our Contributing Guidelines for:

• Setting up the development environment
• Building from source
• Pull request process
• Development roadmap
• Code style guidelines