Git Commit Helper

Interactive CLI tool for generating conventional commit messages based on staged changes.

Features

• 🎯 Analyzes staged git changes
• 📝 Generates 3 conventional commit message options
• 🎨 Interactive selection with arrow keys
• ✅ Follows conventional commits format
• 🚀 No external AI API needed

Installation

Local Development

npm install
npm run dev

Global Installation

npm install -g .

Then use anywhere:

git-cm

Usage

1. Stage your changes:

git add <files>

2. Run the tool:

npm run dev
# or if installed globally:
git-cm

3. Select a commit message with arrow keys and press Enter

4. Confirm the commit

Conventional Commit Types

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• style: Code style changes (formatting, etc.)
• refactor: Code refactoring
• perf: Performance improvements
• test: Adding or updating tests
• build: Build system changes
• ci: CI/CD changes
• chore: Other changes

Example

$ git-cm

🚀 Git Commit Helper

✓ Found 2 staged file(s)

Staged files:
  ~ src/index.ts (+15/-3)
  ✓ src/types.ts (+8/-0)

? Select a commit message:
❯ [1] feat: add user authentication
  [2] feat(auth): add user authentication (with body)
  [3] update 2 files (2 modified)

? Commit with this message?
feat: add user authentication

✓ Commit created successfully!

Development

# Install dependencies
npm install

# Run in dev mode
npm run dev

# Build
npm run build

# Run built version
npm start

License

MIT