Commit Genie – Instant AI commit msg

Commit Genie – Instant AI Commit Msg

Commit Genie is a fast, local, AI-powered tool designed to generate Git commit messages instantly. It works seamlessly with popular AI models like Ollama, OpenAI, or Claude, making it a versatile choice for developers. Built with TypeScript, Commit Genie is lightweight, portable, and free from unnecessary bloat, ensuring a smooth and efficient user experience.

Benefits

Commit Genie offers several key advantages:

• AI-Powered Commit Messages: Automatically generates commit messages from staged Git diffs, saving time and effort.
• Local AI Models: Works with local AI models via Ollama, ensuring privacy and speed.
• Flexible AI Options: Supports OpenAI and Claude APIs for those who prefer cloud-based AI models.
• Conventional Commits: Supports Conventional Commits format with the--conventionalflag, making it ideal for projects that follow this standard.
• Auto-Commit Feature: Includes an optional--commitflag to automatically commit changes, streamlining the workflow.
• Lightweight and Portable: Built with TypeScript, Commit Genie is lightweight and has a tiny footprint, with zero dependencies for core functionality.
• Cross-Platform: Compatible with Windows, Linux, and Mac, making it accessible to a wide range of users.
• Persistent Configuration: Allows users to save settings in a.commitgenrc.jsonfile for persistent configuration.

Use Cases

Commit Genie is particularly useful for:

• Developers: Streamlines the commit process by automatically generating commit messages, allowing developers to focus on coding.
• Teams: Ensures consistency in commit messages, especially when using Conventional Commits, making it easier to maintain a clean and organized Git history.
• Projects: Ideal for both personal and team projects, providing a fast and efficient way to manage Git commits.

Installation

Commit Genie can be installed globally using npm:

npm install -g @cavani21/commit-genie

For a quick try without installation, use:

npx @cavani21/commit-genie --help

Usage

To use Commit Genie, follow these simple steps:

npx commit-genie# Or manually:git add .commit-genie # Generates a commit message from staged changescommit-genie --commit # Also commits itcommit-genie --conventional # Format as Conventional Commit

Example Output

An example of a commit message generated by Commit Genie:

feat: add initial CLI support with local AI (Ollama)

Config

Users can save settings in a.commitgenrc.jsonfile for persistent configuration. Example:

{"provider": "ollama","model": "mistral","conventional": true}

License

Commit Genie is released under the MIT License © 2025.