autocommitt 0.1.8

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 3.2:3B model to create concise, context-aware commit messages while keeping resource usage minimal.

✨ Features

• Local AI-Powered: Generates commit messages using a small 3B parameter Llama 3.2 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
• Resource-Efficient: Minimal computational overhead with lightweight AI model

🚀 Quick Start

Prerequisites

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

Installation

pip install autocommitt

Get the latest updated llama 3.2 (3 billion) model

ollama pull llama3.2:3b

Usage

1. Start the Ollama server:

   autocommitt start
   

2. Generate and edit commit message:

   autocommitt gen
   

   This will generate a commit message based on your changes using the Llama 3.2:3B model. Edit it if needed.

3. Press Enter to commit your changes.

   Note: When you're done generating commit messages, be sure to stop the Ollama server by running:

   autocommitt stop
   

That's it! 🎉

🔜 Roadmap

• Git Hooks Integration: Compatible with pre-commit hooks
• Cross-Platform Support: Enhanced compatibility for Windows, macOS, and Linux
• Custom Templates: Support for user-defined commit message templates
• Interactive Mode: Enhanced CLI interface for improved user experience
• Multiple Language Model Support: Option to choose different local AI models

🐛 Support

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

📊 Project Status

• Basic commit message generation
• Local AI model integration (Llama 3.2:3B)
• Python package release
• Cross-platform testing
• Interactive mode
• Custom template support
• Multi-model 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