Skip to content

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

License

Notifications You must be signed in to change notification settings

shaishab316/xommit

Repository files navigation

xommit

npm version License Downloads Issues Visual Studio Marketplace

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.

VsCode Extension

Xommit Screenshot

https://marketplace.visualstudio.com/items?itemName=shaishab316.xommit-vscode


Installation

npm i -g xommit

Or run without installing globally using npx:

npx xommit

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.
  4. Stage and push the changes to your remote repository.
  5. Also use gitmojis if configured.

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 config - open configuration file in your editor.
  • xommit set <key> <value> - set a configuration value.
  • xommit get <key> - get a configuration value.

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:

npm run dev

Lint and format code:

npm run lint
npm run format

Clean build files:

npm run clean

Links

About

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

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors 2

  •  
  •