gitpal-cli 1.0.1 → 1.0.2

package/README.md

@@ -0,0 +1,308 @@
+# 🤖 GitPal — AI-Powered Git Assistant CLI
+<!-- 
+> Stop writing commit messages manually. Let AI do it in 3 seconds.
+
+[![npm version](https://img.shields.io/npm/v/gitpal-cli.svg?style=flat-square)](https://www.npmjs.com/package/gitpal-cli)
+[![npm downloads](https://img.shields.io/npm/dm/gitpal-cli.svg?style=flat-square)](https://www.npmjs.com/package/gitpal-cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green?style=flat-square)](https://nodejs.org) -->
+
+---
+
+## 😤 The Problem Every Developer Faces
+
+```bash
+# 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
+
+```bash
+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
+
+```bash
+# 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](https://console.groq.com)
+
+---
+
+## 📖 All Commands
+
+### `gitpal commit` — AI Commit Messages
+Reads your staged diff and generates a meaningful conventional commit message.
+
+```bash
+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:**
+```bash
+gitpal commit --yes    # Skip confirmation, commit directly
+```
+
+---
+
+### `gitpal summary` — Plain English Summary
+Summarizes your recent commits so you always know what you built.
+
+```bash
+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:**
+```bash
+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.
+
+```bash
+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:**
+```bash
+gitpal pr --base develop    # Compare against develop branch
+```
+
+---
+
+### `gitpal changelog` — Release Changelog
+Auto-generates a formatted changelog entry from your commit history.
+
+```bash
+gitpal changelog --ver 2.0.0
+
+# 📄 CHANGELOG v2.0.0:
+#
+# ## [2.0.0] - 2026-03-21
+#
+# ### 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.
+
+```bash
+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!
+```
+
+---
+
+## 🔄 Full Daily Workflow
+
+```
+Morning — open your project
+         ↓
+Write some code (auth feature)
+         ↓
+git add .
+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
+```
+
+---
+
+## 💡 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 |
+| 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
+└── tests/
+    └── ai.test.js
+```
+
+---
+
+## 🛠 Local Development
+
+```bash
+# Clone the repo
+git clone https://github.com/harshit_gangwar16/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: [@harshit_gangwar16](https://github.com/harshit_gangwar16)
+- npm: [gitpal-cli](https://www.npmjs.com/package/gitpal-cli)
+
+---
+
+## 📄 License
+
+MIT — free to use, modify and distribute.
+
+---
+
+<p align="center">
+  <strong>If GitPal saves you time, give it a ⭐ on GitHub!</strong>
+</p>

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "gitpal-cli",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "AI-powered Git assistant CLI",
   "main": "src/index.js",
   "bin": {
-    "gitpal": "bin/gitpal.js"
+    "gitpal": "./bin/gitpal.js"
   },
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/.bin/jest"

package/src/commands/changelog.js

@@ -9,7 +9,7 @@ export async function changelogCommand(options) {
     process.exit(1);
   }
 
-  const version = options.ver || "1.0.0";
+  const version = options.version || "1.0.0";
   const n = options.last || 20;
 
   const spinner = ora(`Fetching last ${n} commits for changelog...`).start();

package/src/commands/review.js

@@ -0,0 +1,199 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import inquirer from 'inquirer';
+import { getStagedDiff, doCommit, isGitRepo } from '../git.js';
+import { askAI } from '../ai.js';
+
+export async function reviewCommand(options) {
+  // 1. Guard: must be inside a git repo
+  if (!(await isGitRepo())) {
+    console.log(chalk.red('❌ Not a git repository.'));
+    process.exit(1);
+  }
+
+  // 2. Get staged diff
+  const spinner = ora('Reading your staged changes...').start();
+  const diff = await getStagedDiff();
+
+  if (!diff || diff.trim() === '') {
+    spinner.fail(chalk.yellow('No staged changes found. Run: git add <files>'));
+    process.exit(1);
+  }
+  spinner.succeed('Staged changes found.');
+
+  // 3. Send to AI for review
+  const aiSpinner = ora('AI is reviewing your code...').start();
+
+  const prompt = `You are a senior software engineer doing a code review. Analyze this git diff carefully.
+
+Review the code for:
+1. Bugs or logic errors
+2. Security issues (SQL injection, plain text passwords, exposed keys, etc.)
+3. Missing error handling
+4. Performance issues
+5. Bad practices or code smells
+6. Suggestions for improvement
+
+Format your response EXACTLY like this:
+BUGS:
+- (list any bugs found, or "None found")
+
+SECURITY:
+- (list any security issues, or "None found")
+
+IMPROVEMENTS:
+- (list suggestions, or "None found")
+
+VERDICT: (one of: "Good to commit", "Commit with caution", "Do not commit")
+
+Be specific — mention file names and line numbers when possible.
+Keep each point short and clear.
+
+Git Diff:
+${diff.slice(0, 4000)}`;
+
+  let review;
+  try {
+    review = await askAI(prompt);
+    aiSpinner.succeed(chalk.green('Code review complete!\n'));
+  } catch (err) {
+    aiSpinner.fail(chalk.red(`AI Error: ${err.message}`));
+    process.exit(1);
+  }
+
+  // 4. Parse and display review nicely
+  const lines = review.split('\n');
+  
+  lines.forEach(line => {
+    const trimmed = line.trim();
+    if (!trimmed) return;
+
+    if (trimmed.startsWith('BUGS:')) {
+      console.log(chalk.red.bold('\n🐛 Bugs Found:'));
+    } else if (trimmed.startsWith('SECURITY:')) {
+      console.log(chalk.yellow.bold('\n🔒 Security Issues:'));
+    } else if (trimmed.startsWith('IMPROVEMENTS:')) {
+      console.log(chalk.blue.bold('\n💡 Improvements:'));
+    } else if (trimmed.startsWith('VERDICT:')) {
+      const verdict = trimmed.replace('VERDICT:', '').trim();
+      console.log('');
+      if (verdict.includes('Good to commit')) {
+        console.log(chalk.green.bold(`✅ Verdict: ${verdict}`));
+      } else if (verdict.includes('caution')) {
+        console.log(chalk.yellow.bold(`⚠️  Verdict: ${verdict}`));
+      } else {
+        console.log(chalk.red.bold(`❌ Verdict: ${verdict}`));
+      }
+    } else if (trimmed.startsWith('-')) {
+      // Check content to pick color
+      const lower = trimmed.toLowerCase();
+      if (lower.includes('none found')) {
+        console.log(chalk.green(`  ${trimmed}`));
+      } else if (
+        lower.includes('bug') || lower.includes('error') ||
+        lower.includes('crash') || lower.includes('undefined')
+      ) {
+        console.log(chalk.red(`  ${trimmed}`));
+      } else if (
+        lower.includes('security') || lower.includes('password') ||
+        lower.includes('injection') || lower.includes('exposed')
+      ) {
+        console.log(chalk.yellow(`  ${trimmed}`));
+      } else {
+        console.log(chalk.cyan(`  ${trimmed}`));
+      }
+    } else {
+      console.log(chalk.white(`  ${trimmed}`));
+    }
+  });
+
+  console.log('');
+
+  // 5. Ask what to do next
+  if (options.reviewOnly) return;
+
+  const { action } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'action',
+      message: 'What would you like to do?',
+      choices: [
+        { name: '✅ Looks good — generate commit message and commit', value: 'commit' },
+        { name: '👀 Review looks fine — just show me the diff again', value: 'diff' },
+        { name: '❌ I will fix the issues first', value: 'cancel' },
+      ],
+    },
+  ]);
+
+  if (action === 'cancel') {
+    console.log(chalk.yellow('\nSmart choice! Fix the issues and run gitpal review again.'));
+    return;
+  }
+
+  if (action === 'diff') {
+    console.log(chalk.dim('\n--- Staged Diff ---'));
+    console.log(chalk.white(diff.slice(0, 2000)));
+    return;
+  }
+
+  if (action === 'commit') {
+    // Auto generate commit message after review
+    const commitSpinner = ora('Generating commit message...').start();
+
+    const commitPrompt = `You are an expert developer. Analyze this git diff and write a concise conventional commit message.
+
+Rules:
+- Use conventional commits format: type(scope): description
+- Types: feat, fix, docs, style, refactor, test, chore
+- Keep it under 72 characters
+- Return ONLY the commit message, nothing else
+
+Git Diff:
+${diff.slice(0, 3000)}`;
+
+    try {
+      const message = await askAI(commitPrompt);
+      commitSpinner.succeed(chalk.green('Commit message generated!'));
+
+      console.log('\n' + chalk.bold('Suggested commit message:'));
+      console.log(chalk.cyan(`  ${message}\n`));
+
+      const { confirm } = await inquirer.prompt([
+        {
+          type: 'list',
+          name: 'confirm',
+          message: 'Commit with this message?',
+          choices: [
+            { name: '✅ Yes, commit', value: 'yes' },
+            { name: '✏️  Edit message', value: 'edit' },
+            { name: '❌ Cancel', value: 'cancel' },
+          ],
+        },
+      ]);
+
+      if (confirm === 'cancel') {
+        console.log(chalk.yellow('Cancelled.'));
+        return;
+      }
+
+      let finalMessage = message;
+      if (confirm === 'edit') {
+        const { edited } = await inquirer.prompt([
+          {
+            type: 'input',
+            name: 'edited',
+            message: 'Edit commit message:',
+            default: message,
+          },
+        ]);
+        finalMessage = edited;
+      }
+
+      await doCommit(finalMessage);
+      console.log(chalk.green.bold('\n✅ Reviewed and committed successfully!'));
+
+    } catch (err) {
+      commitSpinner.fail(chalk.red(`Error: ${err.message}`));
+    }
+  }
+}

package/src/index.js

@@ -5,6 +5,7 @@ import { summaryCommand } from './commands/summary.js';
 import { prCommand } from './commands/pr.js';
 import { changelogCommand } from './commands/changelog.js';
 import { configCommand } from './commands/config.js';
+import { reviewCommand } from './commands/review.js';
 
 const program = new Command();
 
@@ -37,7 +38,7 @@ program
 program
   .command('changelog')
   .description('Generate a changelog from commit history')
-  .option('-v, --ver <version>', 'Version number for changelog', '1.0.0')
+  .option('-v, --version <version>', 'Version number for changelog', '1.0.0')
   .option('-n, --last <number>', 'Number of commits to include', '20')
   .action(changelogCommand);
 
@@ -46,6 +47,13 @@ program
   .description('Configure your AI provider and API key')
   .action(configCommand);
 
+program
+  .command('review')
+  .description('AI reviews your code for bugs and issues before committing')
+  .option('-r, --review-only', 'Only review, do not commit')
+  .action(reviewCommand);
+  
+
 program.parse(process.argv);
 
 // Show help if no command given