geminicommit

AI-Powered, Conventional Commit Messages with Google Gemini

geminicommit helps you write clear, conventional, and meaningful Git commit messages automatically using Google Gemini AI. Save time, improve your commit history, and focus on what matters—your code.

---

✨ Features

• AI-Generated Commit Messages: Let Gemini AI analyze your staged changes and suggest concise, descriptive commit messages.
• Customizable Output: Tailor the message style and structure to fit your workflow.
• Conventional Commits: Ensures messages follow best practices for readability and automation.
• Cross-Platform: Works on Linux, Windows, and macOS.
• Open Source: Free to use and contribute.
• Automatic Push: Push committed changes to remote repository with --push flag.
• Advanced Customization: Fine-tune commit messages with various flags and options.
• Smart Issue Detection: Automatically detects and references issue numbers from branch names.

---

🚀 Quickstart

# 1. Install (Go required)
go install github.com/tfkhdyt/geminicommit@latest

# 2. Get your Gemini API key
#    https://aistudio.google.com/app/apikey

# 3. Configure your API key
gmc config key set <your-api-key>

# 4. Stage your changes
git add <file>

# 5. Generate and commit
gmc

---

🛠️ Installation

• From Source:

  go install github.com/tfkhdyt/geminicommit@latest

• Standalone Binary: Download from the releases page and move to a directory in your PATH:
  • Linux: $HOME/.local/bin/ or /usr/local/bin/
  • Windows: %LocalAppData%\Programs\
  • macOS: /usr/local/bin/
• NixOS:

  environment.systemPackages = [
    pkgs.geminicommit
  ];

---

⚙️ Configuration

1. Get your API key from Google AI Studio.
2. Set your key:

   gmc config key set <your-api-key>

---

📖 Usage

1. Stage your changes:

   git add <file>

2. Run the CLI:

   gmc

3. Review and edit the AI-generated message if needed.
4. geminicommit will commit your changes with the generated message.

Advanced Usage & Customization

Commit Message Customization Flags

# Preview commit without making changes
gmc --dry-run

# Display the diff before committing
gmc --show-diff

# Set maximum commit message length (default: 72 characters)
gmc --max-length 50

# Generate commit messages in different languages
gmc --language spanish
gmc --language french

# Reference specific issue numbers
gmc --issue "#123"
gmc --issue "JIRA-456"

# Skip git commit-msg hook verification
gmc --no-verify

# Push committed changes to remote repository
gmc --push

Auto Issue Detection

geminicommit automatically detects issue numbers from branch names using common patterns:

• feature-123-description → references issue #123
• fix-456-bug → references issue #456
• #789-feature → references issue #789
• issue-101 → references issue #101

Combining Options

# Comprehensive example: dry run with diff, custom length, and language
gmc --dry-run --show-diff --max-length 60 --language spanish

# Production workflow: commit and push with issue reference
gmc --issue "#123" --push --no-verify

For more options:

gmc --help

---

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to open an issue or submit a pull request.

---

📄 License

This project is licensed under the GPLv3 License. See the LICENSE file for details.