Commit-Muse

A Git commit-message hook installer that rewrites your commit messages in any style using Google’s Gemini AI.

commit-muse hooks into your project’s Git workflow to automatically “bardify” (rewrite) your commit messages in the style of your choice. Powered by Google’s Gemini API, it transforms raw commit text into a single concise sentence in fun or formal styles—all without leaving your terminal.

Features

• 📜 Automated rewriting of Git commit messages
• 🎭 Custom styles: Shakespeare, Haiku, Formal, and more
• 🔧 Easy installation via npm / npx
• 🔒 Configurable via environment variables
• ⚙️ Built‑in installer to place the commit-msg hook

Installation

Install globally:

npm install -g commit-muse

or install per-project as a dev dependency:

npm install --save-dev commit-muse

Then run the installer to register the Git hook:

npx commit-muse

This copies hook.sh into .git/hooks/commit-msg and makes it executable.

Configuration

Before using, set your Gemini API key and optionally choose a style:

| Variable | Default | Description | | ---------------- | ------------- | ----------------------------------------------------- | | GEMINI_API_KEY | (required) | Your Google Gemini API key | | COMMIT_STYLE | Shakespeare | The writing style to apply (e.g., Shakespeare, Haiku) |

You can set these in your shell:

export GEMINI_API_KEY="YOUR_API_KEY_HERE"
export COMMIT_STYLE="Haiku"

To persist these across sessions, add them to ~/.bashrc, ~/.zshrc, or ~/.bash_profile.

set GEMINI_API_KEY=your-api-key-here
set COMMIT_STYLE=Haiku

To make it permanent, use System Environment Variables or setx.

$env:GEMINI_API_KEY="your-api-key-here"
$env:COMMIT_STYLE="Haiku"

Usage

1. Stage your changes:

   git add .

2. Commit as usual:

   git commit -m "fix user login validation"

   The hook will automatically run, rewriting your message. To try another style, just set COMMIT_STYLE:

   export COMMIT_STYLE="Pirate"
   git commit -m "add user profile page"

3. Observe the output:

   Using style: Haiku
   ✅ Commit message bardified!

4. Push to remote:

   git push

Your AI-enhanced message is now in the commit history.

How It Works

• Installer (bin/install.js): Copies hook.sh into your repo’s .git/hooks/commit-msg and sets the right permissions.

• Commit Hook (hook.sh):

  1. Reads your original commit message.
  2. Sends a prompt (including COMMIT_STYLE) and the message to the Gemini API.
  3. Overwrites the commit message file with the AI’s single-sentence rewrite.

Requirements

• Node.js v12+ (for the installer script)
• jq CLI (for JSON construction and parsing in hook.sh)
• A Git repository with a .git folder

Contributing

Contributions, issues, and feature requests are welcome! Fork the repo and send a PR:

1. Fork and clone
2. Create a feature branch: git checkout -b feature/new-style
3. Commit your changes: git commit -m "feat: add whimsical style option"
4. Push and open a PR

License

MIT © [Your Name]

Made with ❤️ by Sarita