@pieeee/ai-cz

AI-CZ 🤖

AI-powered conventional commit tool with emojis that analyzes your git changes and suggests meaningful commit messages.

Features

• 🧠 AI-powered commit message suggestions using OpenAI
• 📝 Conventional commit format with emojis
• 🔒 Secure local token storage with encryption
• 🎯 Smart scope and type suggestions based on your changes
• 🚀 Simple CLI interface

Installation

npm install -g ai-cz

Usage

Generate a commit (default)

ai-cz

Manage OpenAI API token

ai-cz --token

Get help

ai-cz --help

Setup

• Get your OpenAI API key from OpenAI Platform
• Run ai-cz --token to set up your API key
• Start using ai-cz in any git repository!

How it works

• Analyzes your staged/unstaged git changes
• Sends the diff to OpenAI for analysis
• Suggests appropriate commit types, scopes, and messages
• Lets you select or customize the suggestions
• Creates a beautiful conventional commit with emojis

Example output

feat(auth): ✨ implement OAuth2 login flow
fix(api): 🐛 resolve user data validation error
docs(readme): 📚 add installation instructions

Requirements

• Node.js 18+
• Git repository
• OpenAI API key

License

MIT