Skip to main content

AI-powered git commit message generator using local LLMs

Project description

🤖 komit

AI-powered git commit message generator using local LLMs via Ollama. No API keys, no internet required — runs completely locally and privately.


PyPI Python License Downloads Downloads
📍 View the roadmap · Open an issue · Changelog


Features

  • 🧠 Local LLM — uses Ollama, no API keys needed
  • 📝 Multiple commit styles — conventional, simple, detailed
  • 🔄 Regenerate — not happy? generate a new message instantly
  • ✏️ Edit before commit — open your editor to tweak the message
  • ⚙️ CLI flags — control style, model, and more from the command line
  • 🔔 Auto update check — notifies you when a new version is available
  • 🌍 Universal — works via pip, binary, or shell script
  • Fast — runs on your machine, no network calls to external APIs

Requirements

  • Ollama installed and running
  • A local model pulled (e.g. ollama pull qwen2.5:7b)

Recommended models

Model Size Best for
qwen2.5:7b 4.7GB Best quality
llama3.2:3b 2.0GB Fastest
mistral:7b 4.1GB Good balance
ollama pull qwen2.5:7b

Installation

Linux / macOS — one line

curl -fsSL https://raw.githubusercontent.com/glemiu6/komit/master/scripts/install.sh | bash

pip

pip install komit

pipx (recommended for CLI tools)

pipx install komit

Download binary manually

Download for your platform from GitHub Releases:

Platform Binary
Linux x86_64 komit-linux-x86_64
macOS Apple Silicon komit-macos-arm64
Windows komit-windows-x86_64.exe

Intel Mac/Windows users: use pip install komit instead.

# Linux/macOS
chmod +x komit-*
sudo mv komit-* /usr/local/bin/komit

Setup

Git alias (recommended)

git config --global alias.ai '!komit'

Now you can use git ai as a shortcut.


Usage

# Stage your changes
git add .

# Generate a commit message
komit

# Or via git alias
git ai

CLI flags

komit [--style STYLE] [--model MODEL] [--ollama-url URL] [--max-diff N]
Flag Options Default Description
-s, --style conventional, simple, detailed conventional Commit message style
-m, --model any Ollama model qwen2.5:7b Model to use
-u, --ollama-url any URL http://localhost:11434 Ollama server URL
--max-diff integer 4000 Max diff length sent to model

Examples

komit --style simple
komit --model llama3.2:3b
komit --style detailed --model mistral:7b
komit --ollama-url http://192.168.1.10:11434
komit --max-diff 2000

Interactive prompt

Staged files (3):
  - src/auth.py
  - tests/test_auth.py
  - README.md

Generating commit message... (style: conventional, model: qwen2.5:7b)

Suggested message:
  feat: add JWT authentication with refresh token support

Use this message? (y/n/e to edit/r to regenerate):
Key Action
y Commit with the suggested message
n Cancel
e Open editor to modify the message
r Regenerate a new message

Commit styles

Conventional (default)

feat: add user authentication
fix: resolve null pointer in login flow
docs: update API reference

Simple

Add user authentication
Fix null pointer in login flow
Update API reference

Detailed

feat: add user authentication

- Add JWT token generation
- Add password hashing with bcrypt
- Add refresh token support

Update

komit automatically checks for updates on startup and notifies you when a new version is available.

komit update

Uninstall

All platforms — removes binary, config, and git alias

komit uninstall

Contributing

See CONTRIBUTING.md for setup instructions and guidelines.

  1. Fork the repo
  2. Create a feature branch (git checkout -b feature-name)
  3. Make your changes and add tests
  4. Commit your changes (komit 😉)
  5. Push and open a Pull Request

License

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

komit-0.2.10.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

komit-0.2.10-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file komit-0.2.10.tar.gz.

File metadata

  • Download URL: komit-0.2.10.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for komit-0.2.10.tar.gz
Algorithm Hash digest
SHA256 3d54c19a8ec329648b49befeaf4c9d3d8feba96da11ebcffe443fa3ec99069d1
MD5 eabd2fc9ee7ae8e3ec9e05eda2454a69
BLAKE2b-256 7662a2b15daf44f0b8eacbbd72712c4579d5a206229ac65166f4624483cd7ef5

See more details on using hashes here.

File details

Details for the file komit-0.2.10-py3-none-any.whl.

File metadata

  • Download URL: komit-0.2.10-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for komit-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 5959aac95fb4e4bfa122e7cc9e063c0f56e3b488b5ddc21aa4f93d84249ad185
MD5 436a2daaad210be392abbea2dd83bf7c
BLAKE2b-256 0f92e5e3d1e0e39f3ff20f6b2de53bfd6fecedb663ecf9927d449802afa0afb8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page