autocommitt 0.1.4

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

AutoCommitt is a lightweight CLI tool that automatically generates meaningful commit messages using small, efficient AI models locally. It 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
• Resource Efficient: Minimal RAM and CPU usage with optimized model size
• Privacy-First: All operations performed locally, ensuring data privacy
• Flexible Editing: Review and edit generated messages before committing
• Git Integration: Seamlessly works with your existing Git workflow

🚀 Coming Soon

• Git hooks integration: Compatible with all pre-commit hooks
• Cross-Platform: Support for Windows, macOS, and Linux

🛠️ Installation

Prerequisites

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

Steps

1. Clone the Repository

   git clone https://github.com/yourusername/AutoCommit.git
   cd AutoCommit
   

2. Install Dependencies

   pip install -r requirements.txt
   

3. Verify Installation

   python -m autocommitt --version
   

📖 Usage

python main.py

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please read our Contributing Guidelines for more details.

📊 Project Status

Current Version: 0.1.0 (Alpha)

• 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.