🤖 ai-commit-message: Elevate Your Git Commits with AI Magic! ✨


Welcome to ai-commit-message! 🚀 Transform your git commit experience with AI-powered commit messages. Whether you're using "ai commit message" or "git ai", our tool ensures your commit messages are meaningful and follow the Conventional Commits format.

🎥 Demo

!Demo of AI Commit Message

✨ Features

- 🧠 AI-Powered: Generate insightful commit messages with "ai commit".
- 🎯 Conventional Commits: Adheres to the Conventional Commits standard.
- 🚀 Auto-Commit: Use "ai commit message" to auto-commit your changes.
- ⚡ Fast & Lightweight: Experience seamless integration with "git ai".
- 🔐 Secure: Manage your API keys securely.
- 🎨 Beautiful CLI: Enjoy a colorful command-line interface.

🚀 Installation

``bash
npm install -g ai-commit-message
`

🔑 Setup

1. Obtain your Gemini API key from Get a Gemini API key.

2. Configure the API key for "ai commit message":

`bash
ai-commit-message config
`

Alternatively, set the GEMINI_API_KEY environment variable:

`bash
export GEMINI_API_KEY=
`

💫 Usage

$3

`bash


Stage your changes first

git add .

NOW, Generate a commit message

ai-commit-message
`

$3

`bash
ai-commit-message -c
`

$3

`bash
Commands:
config Configure Gemini API key
generate [options] Generate commit message
help [command] display help for command
`

🛠️ How "ai commit message" Works

1. Verifies you're in a git repository.
2. Checks for staged changes.
3. Sends the diff to Gemini Pro API using gemini-1.5-flash-8b.
4. Generates a conventional commit message.
5. Displays the message or auto-commits (with -c flag).

🧩 Technical Details

- Utilizes the gemini-1.5-flash-8b model for generating commit messages.
- Implements Conventional Commits specification.
- Built with modern ES modules.
- Handles errors gracefully.
- Secure configuration management using conf.

📦 Dependencies

- @google/generative-ai - Google's Gemini AI API.
- commander - CLI framework.
- simple-git - Git operations.
- conf - Configuration management.
- chalk` - Terminal styling.

🔧 Requirements

- Node.js >= 18.0.0
- Git installed and configured
- Gemini API key for "ai commit message"

🤝 Contributing to "ai commit message"

Contributions are welcome! Feel free to:

- 🐛 Report bugs
- 💡 Suggest features
- 🔧 Submit PRs

📝 License

MIT License - feel free to use "ai commit message" in your projects!

---

Made with ❤️ and powered by 🤖 and gemini-1.5-flash-8b