commit-ai

AI-powered git commit message generator that uses your git diff and an optional note as context to generate meaningful Conventional Commits.

Installation

npm install -g commit-ai

Setup

Run once to save your OpenAI API key:

commit-ai config

Usage

# Let AI generate from diff alone
git commit-ai

# Pass a note as context for better results
git commit-ai "fix login bug on mobile"

# Auto-commit without confirmation
git commit-ai "update deps" -y

# Pass note via flag
git commit-ai -n "refactor auth flow"

How it works

1. Reads your staged (or unstaged) git diff
2. Collects branch name, changed files, and recent commits
3. Sends context to OpenAI (gpt-4o-mini)
4. Suggests a Conventional Commit message
5. You choose to commit, edit, copy, or cancel

Commit message format

Follows Conventional Commits:

<type>(<scope>): <description>

Types: feat, fix, refactor, chore, docs, style, test, perf

Requirements

• Node.js 18+
• OpenAI API key → platform.openai.com

License

MIT