commitgenius 0.3.0

An AI-powered CLI tool that generates conventional commit messages using local LLMs via Ollama
commitgenius-0.3.0 is not a library.

🚀 Commitgenius

A powerful CLI tool that generates conventional commit messages using local LLMs via Ollama. Say goodbye to writing commit messages manually!

Crates.io License: MIT

✨ Features

  • 🤖 Generates smart, conventional commit messages using local LLMs
  • 🔄 Automatically manages Ollama service
  • 🎯 Supports multiple Ollama models
  • 🚀 Fast and efficient
  • 💻 Works offline with local models
  • 📝 Automatic git staging with smart file selection

📦 Installation

Using Cargo (All Platforms)

cargo install commitgenius

Using Homebrew (macOS and Linux)

brew tap bannawandoor27/Commitgenius
brew install commitgenius

Using APT (Debian/Ubuntu)

# Add GPG key
curl -fsSL https://bannawandoor27.github.io/Commitgenius/apt-repo/KEY.gpg | sudo gpg --dearmor -o /usr/share/keyrings/commitgenius-archive-keyring.gpg

# Add repository
echo "deb [signed-by=/usr/share/keyrings/commitgenius-archive-keyring.gpg] https://bannawandoor27.github.io/Commitgenius/apt-repo stable main" | sudo tee /etc/apt/sources.list.d/commitgenius.list

# Update and install
sudo apt update
sudo apt install commitgenius

Prerequisites

  • Ollama must be installed on your system
  • Rust and Cargo (if installing via cargo)

🚀 Usage

Basic Usage

  1. Stage and commit all changes:
cmgenius .
  1. Stage and commit specific files:
cmgenius file1.rs file2.rs
  1. Commit already staged changes:
cmgenius

Advanced Usage

Use a different model:

# Stage and commit all changes with a specific model
cmgenius . --model codellama

# Stage and commit specific files with a specific model
cmgenius file1.rs file2.rs --model codellama

# Commit staged changes with a specific model
cmgenius --model codellama

Available models:

  • qwen2.5:7b (default)
  • codellama
  • llama2
  • mistral
  • neural-chat
  • And any other model available in Ollama

Examples

# Stage and commit all changes
cmgenius .

# Stage and commit specific files
cmgenius src/main.rs Cargo.toml

# Commit already staged changes with a specific model
cmgenius --model codellama

# View available options
cmgenius --help

🤝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes using Commitgenius! (cmgenius .)
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📝 License

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

🙏 Acknowledgments

  • Ollama for providing the local LLM infrastructure
  • The Rust community for amazing crates and tools

📧 Contact

Hasanul Banna - @bannawandoor27

Project Link: https://github.com/bannawandoor27/Commitgenius