Automatically generate git commit messages using AI.
Project description
AI Commit Message Generator (acmsg)
A Python tool that automatically generates meaningful git commit messages using AI models through the OpenRouter API.
Features
- Analyzes staged changes in your git repository
- Generates contextual commit messages using AI
- Supports multiple AI models via OpenRouter
- Automatically commits changes with generated message
Prerequisites
- OpenRouter API Key
Installation
With Nix Flakes:
# Add this flake as an input
inputs.acmsg.url = "github:quinneden/acmsg";
# Add the overlay & include the package in your configuration
nixpkgs.overlays = [ inputs.acmsg.overlays.default ];
environment.systemPackages = [ pkgs.acmsg ];
# Or just add the package directly
environment.systemPackages = [ inputs.acmsg.packages.${pkgs.system}.acmsg ];
Usage
# Save api_token configuration value
$ acmsg config set api_token <token_value>
# Optional: Change AI model
acmsg config set model <model>
# Stage your changes first
git add <files>
# Review message & commit
$ acmsg commit
Commit message:
feat(content): add portfolio site content
Do you want to commit? (y/n):
Configuration
You can also configure default settings in ~/.config/git-commit-ai/config.yaml:
api_token: **-**-**-****************************************************************
model: deepseek/deepseek-r1:free # Default model
Contributing
- Fork the repository
- Create a feature branch
- Submit a Pull Request
License
MIT License - See LICENSE file for details
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
acmsg-0.1.0.tar.gz
(4.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
acmsg-0.1.0-py3-none-any.whl
(5.9 kB
view details)
File details
Details for the file acmsg-0.1.0.tar.gz.
File metadata
- Download URL: acmsg-0.1.0.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.2 CPython/3.13.2 Darwin/24.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b814a24da56c251e466b2ba676578a7019a6454dfd2fb06b9efbf049751ec54
|
|
| MD5 |
1072976be296ec3651473c38a4df9c51
|
|
| BLAKE2b-256 |
bd507482359abc79724bdb0a018b15be76eb0f77f1e0ce589f3e0ebbc50b809f
|
File details
Details for the file acmsg-0.1.0-py3-none-any.whl.
File metadata
- Download URL: acmsg-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.2 CPython/3.13.2 Darwin/24.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84625de839d0b5fa0abbf4f0acd6c6af893d48635d83281d954381787560af8c
|
|
| MD5 |
31fdd8dc98f03e79f80da08688a6ac04
|
|
| BLAKE2b-256 |
4c3f7b3c9219ffb7fa3a2c1c18be0b316e14e7da20949d13eec9b8619cf084e5
|