🤖 GitPal — AI-Powered Git Assistant CLI

Stop writing commit messages manually. Let AI do it in 3 seconds.

git add .

😤 The Problem Every Developer Faces

# You just coded for 2 hours and now...
git add .
git commit -m "fix"        # 😭 lazy and meaningless
git commit -m "changes"    # 😭 tells nothing
git commit -m "update"     # 😭 useless history

Your git log becomes a mess. Your team hates you. You hate yourself.

✨ The Solution

git add .
gitpal commit

# ✔ Staged changes found.
# ✔ Commit message generated!
#
# Suggested: feat(auth): add bcrypt password hashing to login endpoint
#
# ? Use this message? › Yes
# ✅ Committed successfully!

GitPal reads your actual code changes and writes the perfect commit message. Every time.

🚀 Quick Start

# Install globally
npm install -g gitpal-cli

# Setup your AI provider (one time only — it's free!)
gitpal config

# Use in any project
cd your-project
git add .
gitpal commit

That's it. You're done.

🤖 Supports 4 AI Providers

Pick any one — all work perfectly:

| Provider | Model | Cost | Speed | |---|---|---|---| | Groq | llama-3.3-70b | 🆓 Free | ⚡ Fastest | | Google Gemini | gemini-pro | 🆓 Free tier | ✅ Fast | | Anthropic | claude-3-haiku | 💰 Free credits | ✅ Fast | | OpenAI | gpt-3.5-turbo | 💰 Paid | ✅ Fast |

💡 Recommended for beginners: Groq — completely free, no credit card needed. Get your key at console.groq.com

📖 All Commands

gitpal commit — AI Commit Messages

Reads your staged diff and generates a meaningful conventional commit message.

git add src/payment.js
gitpal commit

# ✔ Commit message generated!
# Suggested: feat(payment): integrate Razorpay with webhook support
# ? Use this message? › Yes / Edit / Cancel
# ✅ Committed!

Options:

gitpal commit --yes    # Skip confirmation, commit directly

gitpal summary — Plain English Summary

Summarizes your recent commits so you always know what you built.

gitpal summary --last 7

# 📋 Summary of last 7 commits:
# • Built user authentication system with JWT tokens
# • Integrated Razorpay payment gateway
# • Fixed cart total calculation for discounted items
# • Added dark mode to the dashboard
# • Improved API response time using Redis caching

Options:

gitpal summary --last 10    # Summarize last 10 commits

gitpal pr — Pull Request Descriptions

Generates a complete PR description from your branch diff. Copy-paste straight into GitHub.

gitpal pr --base main

# 📝 Pull Request Description:
#
# ## What changed
# - Integrated Razorpay payment gateway
# - Added webhook handler for payment confirmation
# - Added retry logic for failed transactions
#
# ## Why
# - App needed real payment processing for production launch
#
# ## Type of change
# New feature
#
# ## Testing
# Use test card: 4111 1111 1111 1111

Options:

gitpal pr --base develop    # Compare against develop branch

gitpal changelog — Release Changelog

Auto-generates a formatted changelog entry from your commit history.

gitpal changelog --ver 2.0.0

# 📄 CHANGELOG v2.0.0:
#
# ## [2.0.0] - 2026-03-22
#
# ### Features
# - Payment gateway integration
# - Dark mode support
# - User authentication system
#
# ### Bug Fixes
# - Fixed cart calculation for discounts
# - Fixed mobile layout on small screens
#
# ### Improvements
# - 40% faster API response time
# - Reduced bundle size by 20%

gitpal config — Setup AI Provider

Interactive setup to configure your AI provider and API key.

gitpal config

# ? Choose your AI provider:
# ❯ Groq — llama3 (Free & Ultra Fast)
#   Anthropic (Claude)
#   OpenAI (GPT-3.5)
#   Google Gemini
#
# ? Enter your API key: ****************
# ✅ Configuration saved!

gitpal review — AI Code Reviewer

Reviews your staged code for bugs, security issues and bad practices before you commit — like having a senior developer on your team 24/7.

git add .
gitpal review

# 🐛 Bugs Found:
# - No error handling on login failure
#
# 🔒 Security Issues:
# - Password stored as plain text, use bcrypt
#
# 💡 Improvements:
# - Add input validation for username and password
#
# ❌ Verdict: Do not commit

# ? What would you like to do?
# ✅ Looks good — generate commit message and commit
# ❌ I will fix the issues first

Options:

gitpal review --review-only    # Only review, skip commit step

gitpal explain — Explain Any Code

Explains any file, function or commit in plain English — perfect for understanding old code or teammate's changes.

# Explain an entire file
gitpal explain src/auth.js

# 📖 Explaining file: auth.js
# ──────────────────────────────────────────────────
# This file handles all authentication logic.
# It has 4 main functions:
# - login() — verifies user credentials
# - register() — creates new user account
# - verifyToken() — checks if JWT is valid
# - logout() — clears user session
#
# Depends on: bcrypt, jsonwebtoken, User model

# Explain a specific function
gitpal explain src/payment.js --function processPayment

# 📖 Explaining function: processPayment()
# ──────────────────────────────────────────────────
# This function handles Razorpay payment processing.
# Step 1 — Creates payment order with amount
# Step 2 — Sends to Razorpay API
# Step 3 — Waits for webhook confirmation
# Step 4 — Updates database on success
#
# Depends on: razorpay, axios, Order model

# Explain any commit
gitpal explain a3f2c1

# 📖 Explaining commit: a3f2c1
# ──────────────────────────────────────────────────
# This commit added JWT authentication.
# - Created login function with bcrypt password check
# - Added JWT token generation on success
# - Protected private routes with middleware

Options:

gitpal explain src/auth.js                        # Explain full file
gitpal explain src/auth.js --function login       # Explain one function
gitpal explain a3f2c1                             # Explain a commit

🔄 Full Daily Workflow

Morning — open your project
         ↓
Write some code (auth feature)
         ↓
git add .
gitpal review  →  AI checks for bugs and security issues
         ↓
gitpal commit  →  "feat(auth): add Google OAuth login"
         ↓
Write more code (fix a bug)
         ↓
git add .
gitpal commit  →  "fix(cart): resolve total miscalculation"
         ↓
End of day
gitpal summary  →  "Built OAuth, fixed cart bug, added tests"
         ↓
Ready to merge?
gitpal pr  →  Full PR description, copy to GitHub
         ↓
Releasing v2.0?
gitpal changelog --ver 2.0.0  →  Full changelog ready
         ↓
Understanding old code?
gitpal explain src/auth.js  →  Plain English explanation

💡 Why GitPal?

| Without GitPal | With GitPal | |---|---| | git commit -m "fix" | feat(auth): add JWT token refresh logic | | Spend 15 mins on PR description | Generated in 3 seconds | | Forget what you built last week | Plain English summary instantly | | Write changelog manually | Auto-generated from commits | | No code review before commit | AI catches bugs before they reach GitHub | | Confused by old code | Explained in plain English instantly | | Works with one AI only | Works with 4 AI providers |

🗂 Project Structure

gitpal/
├── bin/
│   └── gitpal.js          ← CLI executable
├── src/
│   ├── index.js           ← Main CLI entry (Commander)
│   ├── ai.js              ← Multi-provider AI router
│   ├── git.js             ← Git operations
│   └── commands/
│       ├── commit.js      ← gitpal commit
│       ├── summary.js     ← gitpal summary
│       ├── pr.js          ← gitpal pr
│       ├── changelog.js   ← gitpal changelog
│       ├── config.js      ← gitpal config
│       ├── review.js      ← gitpal review
│       └── explain.js     ← gitpal explain
└── tests/
    └── ai.test.js

🛠 Local Development

# Clone the repo
git clone https://github.com/h1a2r3s4h/gitpal
cd gitpal

# Install dependencies
npm install

# Link globally for testing
npm link

# Configure AI provider
gitpal config

# Try it out
git add .
gitpal commit

🤝 Contributing

Contributions are welcome! To add a new AI provider:

1. Open src/ai.js
2. Add a new callProviderName(prompt, apiKey) function
3. Add a new case in the askAI() switch statement
4. Submit a PR

👨‍💻 Author

Built by Harshit Gangwar

• GitHub: @h1a2r3s4h
• npm: gitpal-cli

📄 License

MIT — free to use, modify and distribute.