xommit

Automatically generate meaningful commit messages using AI by analyzing your git changes. Save time and maintain consistent commit message quality across your projects.

Features

• Generate semantic, conventional commit messages automatically.
• CLI-based, lightweight, and easy to integrate into any workflow.
• Supports AI-driven commit suggestions for consistent commit quality.
• Saves time on repetitive commit message writing.

Installation

npm i -g xommit

Or run without installing globally using npx:

npx xommit

Set Your AI Key

After installation, configure your API key for AI-powered commit suggestions:

xommit setkey "YOUR_GEMINI_KEY"

Usage

After setting your key, run the CLI in your git project:

xommit

The tool will:

1. Analyze staged git changes.
2. Generate a meaningful commit message using AI.
3. Prompt you to accept, edit, or regenerate the commit message.

Example

$ git add . #optional
$ xommit
💡 Generated Commit Message:
docs: add CONTRIBUTING.md and README.md

Adds initial documentation for the project, including a README and
contributing guidelines.
? Proceed with this commit message? (Y/n)

CLI Options

xommit --help

• --help — Display CLI help.
• --version — Display CLI version.

Development

Clone the repository and install dependencies:

git clone https://github.com/shaishab316/xommit.git
cd xommit
npm i

Build the project:

npm run build

Run in development mode (with watch):

npm run dev

Lint and format code:

npm run lint
npm run format

Clean build files:

npm run clean

Links

• Repository: https://github.com/shaishab316/xommit
• Issues: https://github.com/shaishab316/xommit/issues
• Contributing: CONTRIBUTING.md