git-aic 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 Spectra
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,269 @@
+# Git Aic
+
+**git-aic** is a command-line interface (CLI) tool built in TypeScript that upgrades your Git workflow by automatically generating high-quality, conventional commit messages.
+
+Powered by Google Gemini, it analyzes your staged code changes and produces concise, descriptive, and standard-compliant commit messages, helping you maintain a clean and consistent Git history.
+
+You define the rules.  
+You customize the system prompt.  
+You decide when it runs.
+
+Your workflow. Your control.
+
+## Features
+
+- **AI-Powered Message Generation**  
+  Uses Google Gemini API to generate commit messages from your Git diff.
+
+- **Self-Hosted & On-Demand**  
+  Runs locally in your terminal. No background processes. No editor lock-in.
+
+- **Full Control Over Rules**  
+  Modify the system prompt to enforce your own commit conventions and formatting style.
+
+- **Conventional Commits Compliance**  
+  Strictly follows formats like `feat:`, `fix:`, `refactor:`, `chore:`.
+
+- **Commit Confirmation & Editing**  
+  Before committing, you can:
+  - Accept the suggested commit message
+  - Edit the message
+  - Reject it
+  - Retry generation
+
+- **Issue Linking**  
+  Attach commits to GitHub issues with `--issue <number>`.
+
+- **Optional Push After Commit**  
+  Use `-p` or `--push` to push after committing.
+
+- **Config Management**  
+  Set your Gemini API key or view your config:
+  - `git aic config --key <key>`
+  - `git aic config`
+
+- **TypeScript & Type Safety**  
+  Built with TypeScript for maintainability and reliability.
+
+- **Seamless Git Integration**  
+  Directly integrates with Git using a CLI.
+
+## Why Not Just Use Copilot?
+
+Many AI commit tools:
+
+- Depend on editor integrations
+- Limit customization
+- Enforce their defaults
+- Restrict usage
+- Run continuously in the background
+
+This tool is different.
+
+It runs only when you call it.  
+It follows your prompt rules.  
+It generates commits exactly how you define them.  
+It stays out of your way.
+
+There are no forced conventions.  
+No hidden behavior.  
+No unnecessary background processes.
+
+If needed, you can rotate API keys later. You stay in control.
+
+This is controlled automation — not passive AI assistance.
+
+## User Installation
+
+To install `git-aic` globally via npm:
+
+```bash
+npm i -g git-aic
+```
+
+```bash
+git aic --help
+```
+
+## Developer Installation (For Contributors)
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/Spectra010s/git-aic.git
+cd git-aic
+```
+
+### 2. Install Dependencies
+
+```bash
+npm install
+```
+
+### 3. Build the Project
+
+```bash
+npm run build
+```
+
+## Configuration
+
+### Set API Key (Primary)
+
+Use the CLI config command to save your Google Gemini API key:
+
+```bash
+git aic config --key <your_api_key>
+```
+
+To view your current config:
+
+```bash
+git aic config
+```
+
+> "\*Note:\*\* it's masked by default for security reasons
+
+To view the whole current config api key
+
+```bash
+git aic config --show
+```
+
+### Environment Variable (Fallback)
+
+If you prefer not to use the config system, you can set it manually in your environment:
+
+- **macOS / Linux:**
+
+```bash
+export GEMINI_COMMIT_MESSAGE_API_KEY=your_api_key_here
+```
+
+- **Windows (PowerShell):**
+
+```powershell
+setx GEMINI_COMMIT_MESSAGE_API_KEY "your_api_key_here"
+```
+
+After setting the variable, restart your terminal.
+
+> **Note:** This method works, but using the CLI config is safer and easier for long-term usage.
+
+## Usage
+
+### Commit With AI Assistance
+
+```bash
+git aic
+```
+
+- Prompts you with a generated commit message.
+- You can **accept, edit, reject, or retry** the message.
+
+### Commit and Link to Issue
+
+```bash
+git aic --issue 123
+```
+
+- Attaches the commit to GitHub issue #123.
+
+### Commit and Push
+
+```bash
+git aic -p
+```
+
+- Pushes automatically after committing.
+
+### Configure API Key
+
+```bash
+git aic config --key <key>
+```
+
+- Saves your Google Gemini API key.
+
+```bash
+git aic config
+```
+
+- Displays your saved config.
+
+That’s it.
+
+No need to manually write commit messages anymore.
+
+## How It Works
+
+1. Captures your staged Git diff
+2. Builds a strict system prompt
+3. Sends the diff to Gemini
+4. Enforces Conventional Commit formatting
+5. Prompts for commit confirmation (accept, edit, retry, reject)
+6. Executes `git commit` automatically
+7. Optionally pushes if `-p` flag is used
+
+You can modify commit behavior by editing:
+
+```
+src/prompt.ts
+```
+
+---
+
+## Technologies Used
+
+| Technology        | Purpose                |
+| ----------------- | ---------------------- |
+| TypeScript        | Core language          |
+| Node.js           | Runtime                |
+| Axios             | HTTP client            |
+| Chalk             | Styled terminal output |
+| Commander.js      | CLI framework          |
+| Simple-Git        | Git integration        |
+| Google Gemini API | LLM text generation    |
+
+## Final Takeaway
+
+Automating repetitive tasks like **commit messages** saves time — but the real win here is ownership.
+
+git-aic:
+
+- **Self-hosted** — runs entirely on your machine
+- **On-demand** — only runs when you call it
+- **Fully customizable** — prompts, commit format, workflow
+- **Under your control** — you decide every step
+
+It runs when you need it, follows your rules, and generates commits the way **you** want.
+
+_Choose your model. Define your prompt. Control the format. Extend or optimize anytime._
+
+Instead of adapting to someone else's defaults, _you built a system tailored to your workflow._
+
+You are not just using AI tools.  
+You are **building them to fit your process.**
+
+## License
+
+[**ISC License**](https://github.com/Spectra010s/git-aic/main/#license)
+
+## Author
+
+Spectra010s
+
+- [Twitter](https://x.com/Spectra010s)
+- [LinkedIn](https://www.linkedin.com/in/adeloye-adetayo-273723253)
+
+## Parent Repository
+
+This project is a fork and standalone version of:
+
+[https://github.com/samueltuoyo15/Commit-Message-Tool](https://github.com/samueltuoyo15/Commit-Message-Tool)
+
+---
+
+![License](https://img.shields.io/badge/License-ISC-blue.svg)
+![TypeScript](https://img.shields.io/badge/Language-TypeScript-blue?style=flat&logo=typescript&logoColor=white)
+![Node.js](https://img.shields.io/badge/Runtime-Node.js-green?style=flat&logo=nodedotjs&logoColor=white)

package/dist/cli.js

@@ -5,13 +5,45 @@ import chalk from "chalk";
 import { getGitDiff } from "./git.js";
 import { generateCommitMessage } from "./llm.js";
 import { getUserConfirmation } from "./confirm.js";
+import { getConfig, setApiKey } from "./config.js";
+process.on("SIGINT", () => {
+    process.exit(0);
+});
 const git = simpleGit();
 const program = new Command();
 program
-    .name("commit")
+    .name("git aic")
     .description("AI-powered Git commit generator using Google Gemini")
     .version("1.0.0")
-    .option("-p, --push", "push after committing");
+    .option("-p, --push", "push after committing")
+    .option("-i, --issue <number>", "Link commit to GitHub issue");
+program
+    .command("config")
+    .description("Configure the Gemini API Key settings")
+    .option("-k, --key <key>", "Set your Gemini API Key")
+    .option("--show", "Show the full API key")
+    .action(async (options) => {
+    const cfg = await getConfig();
+    if (options.key) {
+        await setApiKey(options.key);
+        console.log(chalk.green("API Key saved successfully!"));
+        return;
+    }
+    if (cfg.apiKey) {
+        if (options.show) {
+            console.log(chalk.green("Current API Key:"), cfg.apiKey);
+        }
+        else {
+            const styled = cfg.apiKey.slice(0, 4) +
+                chalk.dim("*".repeat(cfg.apiKey.length - 8)) +
+                cfg.apiKey.slice(-4);
+            console.log(chalk.green("Current API Key:"), styled);
+        }
+    }
+    else {
+        console.log(chalk.yellow("No API key set"));
+    }
+});
 program.action(async (options) => {
     try {
         const diff = await getGitDiff();
@@ -23,17 +55,20 @@ program.action(async (options) => {
         console.log(chalk.blue("\nFiles being committed:"));
         status.staged.forEach((file) => console.log(chalk.cyan(`- ${file}`)));
         console.log("");
-        let currentMessage = "";
+        let currentMsg = "";
         let confirmed = false;
+        let finalMsg = "";
+        const issueSuffix = options.issue ? `, closes #${options.issue}` : "";
         console.log(chalk.blue("Analyzing staged changes...\n"));
         while (!confirmed) {
-            currentMessage = await generateCommitMessage(diff);
-            const { choice, message } = await getUserConfirmation(currentMessage);
-            if (choice === 'y') {
-                currentMessage = message;
+            let currentMsg = await generateCommitMessage(diff);
+            currentMsg = `${currentMsg}${issueSuffix}`;
+            const { choice, message } = await getUserConfirmation(currentMsg);
+            if (choice === "y") {
+                finalMsg = message;
                 confirmed = true;
             }
-            else if (choice === 'r') {
+            else if (choice === "r") {
                 console.log(chalk.yellow("Regenerating...\n"));
                 continue;
             }
@@ -42,8 +77,8 @@ program.action(async (options) => {
                 process.exit(0);
             }
         }
-        console.log(chalk.blue(`> ran: git commit -m "${currentMessage}"`));
-        await git.commit(currentMessage);
+        console.log(chalk.blue(`> ran: git commit -m "${finalMsg}"`));
+        await git.commit(finalMsg);
         console.log(chalk.green("\nCommit successful"));
         if (options.push) {
             console.log(chalk.blue("> ran: git push"));
@@ -52,8 +87,14 @@ program.action(async (options) => {
         }
     }
     catch (error) {
-        console.error(chalk.red("\nCommit failed:"), error);
-        process.exit(1);
+        let isAbort = false;
+        if (typeof error === "object" && error !== null && "code" in error) {
+            const e = error;
+            isAbort = e.code === "ABORT_ERR";
+        }
+        const msg = isAbort ? "Operation cancelled" : error;
+        console.error(chalk.red("\n\nCommit failed:"), msg);
+        process.exit(isAbort ? 0 : 1);
     }
 });
 program.parse(process.argv);

package/dist/config.js

@@ -0,0 +1,41 @@
+import fs from "fs/promises";
+import path from "path";
+import os from "os";
+import chalk from "chalk";
+function getConfigPath() {
+    const toolName = "git-aic";
+    if (process.platform === "win32") {
+        const appData = process.env.APPDATA;
+        if (!appData)
+            throw new Error("APPDATA not defined");
+        return path.join(appData, toolName, "config.json");
+    }
+    else {
+        const configDir = path.join(os.homedir(), ".config", toolName);
+        return path.join(configDir, "config.json");
+    }
+}
+export async function getConfig() {
+    const configPath = getConfigPath();
+    try {
+        const content = await fs.readFile(configPath, "utf-8");
+        return JSON.parse(content);
+    }
+    catch (err) {
+        if (err.code === "ENOENT")
+            return {};
+        console.error(chalk.red("Failed to read config:"), err.message);
+        return {};
+    }
+}
+export async function saveConfig(data) {
+    const configPath = getConfigPath();
+    const dir = path.dirname(configPath);
+    await fs.mkdir(dir, { recursive: true });
+    const current = await getConfig();
+    const newConfig = { ...current, ...data };
+    await fs.writeFile(configPath, JSON.stringify(newConfig, null, 2), "utf-8");
+}
+export async function setApiKey(key) {
+    await saveConfig({ apiKey: key });
+}

package/dist/confirm.js

@@ -6,20 +6,26 @@ export const getUserConfirmation = async (message) => {
         output: process.stdout,
     });
     console.log(chalk.green(`\nProposed: "${message}"`));
-    const answer = await rl.question(chalk.blue('Confirm commit? [y=yes, n=no, r=retry, e=edit]: '));
+    const answer = await rl.question(chalk.blue("Confirm commit? [y=yes, n=no, r=retry, e=edit]: "));
     rl.close();
-    const choice = (answer.toLowerCase() || 'y').trim();
-    if (choice === 'e') {
+    const choice = (answer.toLowerCase() || "y").trim();
+    if (choice === "e") {
         const editRl = readline.createInterface({
             input: process.stdin,
             output: process.stdout,
-            terminal: true
+            terminal: true,
         });
         console.log(chalk.cyan("\nEdit the message:"));
         editRl.write(message);
-        const editedMessage = await editRl.question("> ");
+        let editedMessage = "";
+        while (!editedMessage.trim()) {
+            editedMessage = await editRl.question("> ");
+            if (!editedMessage.trim()) {
+                console.log(chalk.red("Commit message cannot be empty. Please type something."));
+            }
+        }
         editRl.close();
-        return { choice: 'y', message: editedMessage };
+        return { choice: "y", message: editedMessage };
     }
     return { choice, message };
 };

package/dist/llm.js

@@ -1,18 +1,21 @@
 import axios from "axios";
 import chalk from "chalk";
 import { buildPrompt } from "./prompt.js";
+import { getConfig } from "./config.js";
 export const generateCommitMessage = async (rawDiff) => {
     const API_URL = "https://generativelanguage.googleapis.com/v1/models/gemini-2.5-flash:generateContent";
-    const API_KEY = process.env.GEMINI_COMMIT_MESSAGE_API_KEY;
+    const config = await getConfig();
+    const API_KEY = config.apiKey || process.env.GEMINI_COMMIT_MESSAGE_API_KEY;
     if (!API_KEY) {
         console.error(chalk.red("\nMissing GEMINI_COMMIT_MESSAGE_API_KEY environment variable.\n"));
         console.log("Please set your API key before running this command.\n");
         console.log(chalk.yellow("How to fix this:\n"));
-        console.log(chalk.cyan("macOS / Linux:"));
+        console.log(chalk.gray("Recommended: use the config helper to save it permanently:\n  git-aic config --key <your_api_key>\n"));
+        console.log(chalk.cyan("macOS / Linux (temporary):"));
         console.log("  export GEMINI_COMMIT_MESSAGE_API_KEY=your_api_key_here\n");
-        console.log(chalk.cyan("Windows (PowerShell):"));
+        console.log(chalk.cyan("Windows (PowerShell, temporary):"));
         console.log('  setx GEMINI_COMMIT_MESSAGE_API_KEY "your_api_key_here"\n');
-        console.log(chalk.gray("After setting the variable, restart your terminal.\n"));
+        console.log(chalk.gray("After setting the key, restart your terminal.\n"));
         process.exit(1);
     }
     const prompt = buildPrompt(rawDiff);

package/dist/prompt.js

@@ -1,44 +1,44 @@
-export const buildPrompt = (diff) => `
-CRITICAL INSTRUCTIONS - READ CAREFULLY:
-You are an expert Git commit message writer. You MUST follow ALL these rules:
-
-1. FORMAT: Use Conventional Commits format: <type>(<scope>): <description>
-   - type: MUST be one of: feat, fix, refactor, chore, docs, style, test, perf
-   - scope: Should be the module/file affected (e.g., "auth", "api", "ui", "config")
-   - description: Clear, imperative description in present tense
-
-2. DESCRIPTION REQUIREMENTS:
-   - Start with an imperative verb (add, fix, remove, update, refactor, etc.)
-   - Be specific about what changed
-   - Keep it under 72 characters total (including type and scope)
-   - NO trailing punctuation
-   - NO emojis ever
-   - MUST be a complete sentence
-
-3. MESSAGE STRUCTURE:
-   - The entire commit message must be exactly one line
-   - Format: type(scope): description
-   - Example: "feat(auth): add password reset functionality"
-   - Example: "fix(api): handle null response in user endpoint"
-   - Example: "refactor(ui): simplify component state management"
-
-4. QUALITY CHECKS - YOUR OUTPUT MUST PASS:
-   - Contains opening and closing parentheses
-   - Has a colon after the parentheses
-   - Description exists and is not empty
-   - Total length ≤ 72 characters
-   - No markdown formatting
-   - No code blocks
-   - No explanations or notes
-
-5. FAILURE MODE:
-   - If you cannot generate a proper message, return exactly: "chore: update code"
-
-YOUR TASK:
-Analyze this git diff and generate exactly ONE proper commit message following all rules above.
-
-Git diff:
-${diff}
-
-Commit message:
+export const buildPrompt = (diff) => `
+CRITICAL INSTRUCTIONS - READ CAREFULLY:
+You are an expert Git commit message writer. You MUST follow ALL these rules:
+
+1. FORMAT: Use Conventional Commits format: <type>(<scope>): <description>
+   - type: MUST be one of: feat, fix, refactor, chore, docs, style, test, perf
+   - scope: Should be the module/file affected (e.g., "auth", "api", "ui", "config")
+   - description: Clear, imperative description in present tense
+
+2. DESCRIPTION REQUIREMENTS:
+   - Start with an imperative verb (add, fix, remove, update, refactor, etc.)
+   - Be specific about what changed
+   - Keep it under 72 characters total (including type and scope)
+   - NO trailing punctuation
+   - NO emojis ever
+   - MUST be a complete sentence
+
+3. MESSAGE STRUCTURE:
+   - The entire commit message must be exactly one line
+   - Format: type(scope): description
+   - Example: "feat(auth): add password reset functionality"
+   - Example: "fix(api): handle null response in user endpoint"
+   - Example: "refactor(ui): simplify component state management"
+
+4. QUALITY CHECKS - YOUR OUTPUT MUST PASS:
+   - Contains opening and closing parentheses
+   - Has a colon after the parentheses
+   - Description exists and is not empty
+   - Total length ≤ 72 characters
+   - No markdown formatting
+   - No code blocks
+   - No explanations or notes
+
+5. FAILURE MODE:
+   - If you cannot generate a proper message, return exactly: "chore: update code"
+
+YOUR TASK:
+Analyze this git diff and generate exactly ONE proper commit message following all rules above.
+
+Git diff:
+${diff}
+
+Commit message:
 `.trim();

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "git-aic",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "AI-powered Git commit generator using Google Gemini",
-  "homepage": "https://github.com/samueltuoyo15/Commit-Message-Tool/tree/#readme",
+  "homepage": "https://github.com/Spectra010s/git-aic",
   "bugs": {
-    "url": "https://github.com/samueltuoyo15/Commit-Message-Tool/issues"
+    "url": "https://github.com/Spectra010s/git-aic/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/samueltuoyo15/Commit-Message-Tool.git"
+    "url": "git+https://github.com/Spectra010s/git-aic.git"
   },
   "license": "ISC",
   "author": "Spectra010s",
@@ -17,9 +17,6 @@
   "bin": {
     "git-aic": "./dist/cli.js"
   },
-    "files": [
-    "dist"
-  ],
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build"

package/t.txt

@@ -0,0 +1,32 @@
+# Git Aic v1.1.0
+
+## Highlights
+- Fully standalone CLI — removed dependency on the original form network.
+- AI-powered commit message generation with Google Gemini.
+- Commit confirmation now gracefully exits if canceled.
+- Empty commit messages are prevented during editing in confirmation prompt.
+- `--issue` option added to link commits to GitHub issues.
+- Flattened project structure for cleaner code organization.
+- Axios errors for LLM requests are now handled properly to avoid crashes.
+- CLI config system for managing your API key.
+- Environment variable fallback supported.
+- README updated with full usage, installation, and features.
+
+## Improvements
+- TypeScript & type-safe implementation.
+- Improved user experience — prompts only run when called.
+- Conventional commit compliance enforced.
+- Clear separation between developer install (contributors) and user install (global npm).
+
+## Notes
+- Editable prompt system is not yet included — planned for v1.2.0.
+- Users can now run `git aic` globally via npm.
+
+## What's Changed
+• refactor(project): flatten project structure and update config by @Spectra010s in https://github.com/Spectra010s/git-aic/pull/1  
+• feat(cli): add --issue option to link commit to an issue, closes #3 by @Spectra010s in https://github.com/Spectra010s/git-aic/pull/4  
+• prevent empty commit message when editing in confirmation prompt by @Spectra010s in https://github.com/Spectra010s/git-aic/pull/6  
+• fix(cli): handle graceful process exit on cancellation, closes #7 by @Spectra010s in https://github.com/Spectra010s/git-aic/pull/8  
+• fix(llm): handle Axios errors for LLM requests by @Spectra010s in https://github.com/Spectra010s/git-aic/pull/10  
+
+Full Changelog: https://github.com/Spectra010s/git-aic/commits/v1.1.0