Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ai-commit-message

imshaiknasir501.3.1

AI-powered git commit message generator using Gemini API

ai-commit-message, ai commit message, ai commit, git ai, git commit, ai-commit-generator, ai-commit-tool, ai-commit-cli, commit-message-generator, commit-message-tool, commit-message-cli, commit-message-with-ai, commit-message-generator-with-ai, commit-message-tool-with-ai, commit-message-cli-with-ai, AI commit message generator, npm package, npm package for commit messages, ai generate commit messages, generate commit messages with AI, Gemini API, git commit messages, conventional commits, automated commit messages, CLI tools for developers, Node.js commit message generator, GitHub actions, open source commit message tool, Gemini Pro API integration, AI-powered development tools, automated software engineering, commit message best practices, AI in software development, git automation tools, developer productivity tools, AI-driven commit message generation, AI commit automation, AI git integration, AI-enhanced git workflow, smart commit messages, intelligent commit messages, AI commit message assistant

readme

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

Node.js Version License: MIT

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

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":

ai-commit-message config <your-api-key>

Alternatively, set the GEMINI_API_KEY environment variable:

export GEMINI_API_KEY=<your-api-key>

💫 Usage

Generate a Commit Message with "ai commit"

# Stage your changes first
git add .

# NOW, Generate a commit message
ai-commit-message

Generate and Auto-Commit with "ai commit message"

ai-commit-message -c

CLI Options for "ai commit message"

Commands:
  config <key>        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