acmsg

Automated Commit Message Generator

The acmsg repository offers a command-line interface (CLI) tool developed in Python, designed to enhance the process of generating git commit messages. Utilizing the powerful OpenRouter API, this tool leverages AI models to produce meaningful and context-aware commit messages, streamlining development workflows.

Key Features

• Contextual Analysis: acmsg analyzes staged changes within your git repository, ensuring that generated commit messages are relevant to the modifications made.
• AI-Powered Generation: With support for multiple AI models through OpenRouter, acmsg provides flexibility in generating messages that suit various coding styles or project needs.
• Edit and Confirm: The tool allows users to edit generated commit messages if desired, adding a layer of customization.
• Automated Committing: Upon confirmation, acmsg can automatically commit changes with the generated messages, facilitating a smoother development process.

Getting Started

To use acmsg, an OpenRouter API Key is required. Once set up, the configuration file can be easily managed at ~/.config/acmsg/config.yaml, which includes an initial prompt to enter the API token. Additional settings can be adjusted using the command:

$ acmsg config set api_token <your_api_token>

Usage Example

acmsg provides intuitive commands for generating commit messages. Here is a brief overview of its commands:

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

Embrace the efficiency of AI in your version control process with acmsg, the automated commit message generator.