https://github.com/quinneden/acmsg
AI generated git commit messages using the OpenRouter API.
https://github.com/quinneden/acmsg
ai commit-message-generator git-commit-messages openrouter python
Last synced: about 1 month ago
JSON representation
AI generated git commit messages using the OpenRouter API.
- Host: GitHub
- URL: https://github.com/quinneden/acmsg
- Owner: quinneden
- License: mit
- Created: 2025-03-31T05:01:05.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-05-16T15:55:32.000Z (9 months ago)
- Last Synced: 2025-10-26T20:50:19.945Z (4 months ago)
- Topics: ai, commit-message-generator, git-commit-messages, openrouter, python
- Language: Python
- Homepage:
- Size: 173 KB
- Stars: 29
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# acmsg (automated commit message generator)
A cli tool written in Python that generates git commit messages using AI models
through the OpenRouter API.
[](https://github.com/quinneden/acmsg/actions/workflows/publish-and-release.yaml)
[](https://github.com/quinneden/acmsg/actions/workflows/test.yaml)
## Features
- Analyzes staged changes in your git repository
- Generates contextual commit messages using AI
- Supports multiple AI models via [OpenRouter](https://openrouter.ai)
- Optionally edit generated commit message
- Automatically commits changes with generated message, if confirmed
## Prerequisites
- OpenRouter API Key
## Installation
### with pipx:
```bash
pipx install acmsg
```
### with nix:
using flakes (i.e. nixos/nix-darwin/home-manager):
```bash
# Add `acmsg` to your flake inputs
inputs.acmsg.url = "github:quinneden/acmsg";
# Add the nixpkgs overlay & include the package in your configuration
nixpkgs.overlays = [ inputs.acmsg.overlays.default ];
environment.systemPackages = [ pkgs.acmsg ];
# or home.packages = [ pkgs.acmsg ];
# Or include the package directly from inputs
environment.systemPackages = [ inputs.acmsg.packages.${pkgs.system}.acmsg ];
```
using a standalone profile:
```bash
$ nix profile install "github:quinneden/acmsg"
```
## Configuration
The configuration file is located at `~/.config/acmsg/config.yaml`.
On first run, acmsg will prompt you to configure your OpenRouter API token.
You can also run the following command:
```bash
$ acmsg config set api_token
```
## Usage
```
usage: acmsg [-h] [--version] {commit,config} ...
Automated commit message generator
positional arguments:
{commit,config} Commands
commit generate a commit message
config manage configuration settings
options:
-h, --help show this help message and exit
--version display the program version and exit
```
## License
acmsg is licenced under the MIT License, as included in the [LICENSE](LICENSE) file.