@abhaydesu/git-pilot 1.1.0 → 1.2.0

package/README.md

@@ -1,104 +1,84 @@
 <div align="center" display="inline">
-  <img width="30" height="30" alt="logo" src="./public/logo-pilot.png" />
+  <img width="40" height="40" alt="logo" src="./public/logo-dark-new.png" />
 </div>
 
-# Git Pilot API
+# Git Pilot 
 
-This is the backend API server that powers the <a href="https://www.npmjs.com/package/@abhaydesu/git-pilot">`git-pilot`</a> CLI tool. It handles the secure communication with AI models to generate Git commands, commit messages, undo actions, and branch names.
+[![NPM Version](https://img.shields.io/npm/v/@abhaydesu/git-pilot)](https://www.npmjs.com/package/@abhaydesu/git-pilot)
 
-## ◼️ Purpose
+An AI-powered assistant that lives in your command line to streamline your Git workflow. Never write a commit message or look up a command again.
 
-The primary role of this API is to act as a secure intermediary between the <a href="https://github.com/abhaydesu/git-pilot-cli">`git-pilot-cli` </a> and the AI service (Google Gemini). This architecture ensures that the AI API keys are never exposed on a user's local machine.
+---
 
-## ◼️ Technology Stack
+## The Problem
+Remembering complex commands like interactive rebase can be a pain. Writing well-formatted commit messages is a chore. Git is powerful, but its interface can sometimes get in the way of a fast workflow.
 
-* **Runtime:** Node.js
-* **Framework:** Express.js
-* **AI Service:** Google Gemini API
-* **Deployment:** Vercel
+**Git Pilot** solves this by acting as your intelligent copilot, translating your natural language intent into the exact commands and messages you need.
 
-## ◼️ API Endpoints
+## Features
+* **AI-Powered Commit Messages:** Analyzes your staged changes (`git diff`) and generates a perfect commit message following the Conventional Commits specification. Just run `git pilot commit <your_intent>`
+* **Natural Language to Git Command:** Translate plain English requests like "squash the last 3 commits" into the precise Git command. One simple `git pilot run <your_request>`
+* **Magic Undo:** Made a mistake? `git pilot undo` analyzes your recent history and suggests the exact command to reverse your last action.
+* **Intelligent Branching:** Describe your goal, and `git pilot branch` will create a clean, conventional branch name for you.
+* **Interactive & Safe:** Always asks for your confirmation before executing any command. You can also **edit** any AI suggestion to get it just right.
 
-The API exposes the following endpoints:
+## Installation
+Make sure you have Node.js (v18+) and Git installed. Then, run the following command to install Git Pilot globally:
 
-### 1. Generate Commit Message
+```bash
+npm install -g @abhaydesu/git-pilot
+```
 
-* **Route:** `POST /api/pilot-commit`
-* **Description:** Analyzes a Git diff and a user's intent to generate a conventional commit message.
-* **Request Body (JSON):**
+### ◾ Usage
 
-  ```json
-  {
-    "intent": "string",
-    "diff": "string"
-  }
-  ```
-* **Success Response (200 - JSON):**
+#### *Generating a Commit Message*
+Stage your files (git add .), then run git pilot commit. This command analyzes your staged changes and generates a conventional commit message.
 
-  ```json
-  {
-    "message": "string"
-  }
-  ```
+##### With an Intent
+Provide a brief description of your changes, and the AI will use it to write the commit message.
 
-### 2. Generate Git Command
+```Bash
 
-* **Route:** `POST /api/pilot-run`
-* **Description:** Translates a user's natural language request into an executable, safe Git command.
-* **Request Body (JSON):**
+git pilot commit "add new user profile page"
+```
 
-  ```json
-  {
-    "request": "string"
-  }
-  ```
-* **Success Response (200 - JSON):**
+##### Without an Intent
+If you don't provide an intent, the AI will analyze the diff of your staged files and generate a message automatically.
 
-  ```json
-  {
-    "command": "string"
-  }
-  ```
+```Bash
 
-### 3. Undo Last Action
+git pilot commit
+```
+After running, you can accept, edit, or abort the suggested commit.
 
-* **Route:** `POST /api/pilot-undo`
-* **Description:** Suggests a safe Git command to undo the most recent significant action (merge, rebase, commit).
-* **Request Body (JSON):**
 
-  ```json
-  {
-    "reflog": "string"
-  }
-  ```
-* **Success Response (200 - JSON):**
+#### *Running a Git Command*
+Run the run command with the task you want to perform. The tool will suggest a command and ask for confirmation.
 
-  ```json
-  {
-    "command": "string",
-    "explanation": "string"
-  }
-  ```
+```Bash
 
-### 4. Generate Branch Name
+git pilot run "cherry-pick the last commit from the main branch" 
+```
 
-* **Route:** `POST /api/pilot-branch`
-* **Description:** Converts a natural language description into a conventional, kebab-case Git branch name.
-* **Request Body (JSON):**
+#### *Creating a New Branch*
+Describe the purpose of your new branch, and let the AI generate a conventional name.
 
-  ```json
-  {
-    "description": "string"
-  }
-  ```
-* **Success Response (200 - JSON):**
+```Bash
 
-  ```json
-  {
-    "branchName": "string"
-  }
-  ```
+git pilot branch "create a new feature for the auth system"
+```
 
-### ◾ Deployment
+#### *Undoing a Mistake*
 
-This API is designed for and deployed on Vercel.
+If you've made a mistake (like a bad commit or merge), this command will analyze your history and suggest the safest way to undo it.
+
+```Bash
+
+git pilot undo 
+```
+
+### ◾ How It Works
+Git Pilot is a CLI tool that communicates with a secure backend API. This API uses Google's Gemini models to understand your intent and analyze code, keeping your API keys safe and off your local machine.
+
+### ◾ License
+This project is licensed under the MIT License.

package/index.js

@@ -33,8 +33,8 @@ program
   .command("commit")
   .description("Generate an AI-powered commit message.")
   .argument(
-    "<string>",
-    'The user\'s intent for the commit (e.g., "add a new feature")'
+    "[intent]",
+    'Optional: The user\'s intent for the commit (e.g., "add a new feature")'
   )
   .action(async (intent) => {
     const spinner = ora("Analyzing your staged changes...").start();
@@ -48,12 +48,25 @@ program
       process.exit(0);
     }
 
+    const MAX_PAYLOAD_SIZE = 4 * 1024 * 1024; 
+    const diffSize = Buffer.byteLength(diff, 'utf8');
+    let diffToSend = diff;
+
+    if (diffSize > MAX_PAYLOAD_SIZE) {
+      
+      const { stdout: diffSummary } = await execa("git", ["diff", "--staged", "--name-status"]);
+      
+      diffToSend = "The staged changes are too large to display the full diff. " +
+                   "Please generate a commit message based on the user's intent and this summary of changed files:\n\n" +
+                   diffSummary;
+    }
+
     try {
       spinner.text = "Generating commit message...";
 
       const response = await axios.post(
         API_COMMIT_URL,
-        { intent, diff },
+        { intent, diff: diffToSend },
         { timeout: 30000 }
       );
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abhaydesu/git-pilot",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
   "main": "index.js",
   "scripts": {