commitmind 1.0.1 → 1.0.3

package/README.md

@@ -1,15 +1,185 @@
-# ai-commit-gen
+#  CommitMind
 
-To install dependencies:
+![npm](https://img.shields.io/npm/v/commitmind)
+![downloads](https://img.shields.io/npm/dw/commitmind)
+![license](https://img.shields.io/npm/l/commitmind)
+
+**CommitMind** is an AI-powered Git CLI that automatically generates clean, meaningful commit messages using local LLMs via **Ollama**.
+
+Stop wasting time writing commit messages. Let AI handle it — fast, private, and fully local.
+
+---
+
+## Demo 
+
+![Screenshot](https://raw.githubusercontent.com/Nabin-09/ai-commit-generator/main/images/ss1.png)
+
+##  Features
+
+*  AI-generated semantic commit messages
+*  Fast and local (no cloud, no API keys)
+*  Privacy-first — your code never leaves your machine
+*  Auto stage, commit, and push
+*  Conventional commit format
+*  Works in any Git project
+*  Cross-platform (Windows, Mac, Linux)
+
+---
+
+##  Installation
+
+Install globally:
+
+```bash
+npm install -g commitmind
+```
+
+Or with Bun:
+
+```bash
+bun add -g commitmind
+```
+
+---
+
+##  Requirements
+
+CommitMind uses **Ollama** to run AI locally.
+
+###  Install Ollama
+
+Download from:
+👉 https://ollama.com
+
+###  Start Ollama
+
+```bash
+ollama serve
+```
+
+###  Pull the model
+
+```bash
+ollama pull llama3
+```
+
+---
+
+##  Usage
+
+###  Auto generate commit message
+
+```bash
+aic auto
+```
+
+This will:
+
+1. Stage all changes
+2. Generate an AI commit message
+3. Commit automatically
+
+---
+
+###  Commit and push
 
 ```bash
-bun install
+aic push main
 ```
 
-To run:
+This will:
+
+1. Stage changes
+2. Generate commit
+3. Commit
+4. Push to branch
+
+---
+
+##  Example Workflow
 
 ```bash
-bun run index.ts
+git checkout -b feature-auth
+# make changes
+aic auto
+aic push main
 ```
 
-This project was created using `bun init` in bun v1.3.4. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+---
+
+##  Why CommitMind?
+
+Writing commit messages is repetitive and often ignored.
+CommitMind helps maintain:
+
+* Clean project history
+* Semantic commits
+* Faster workflow
+* Better collaboration
+
+All while keeping your data private.
+
+---
+
+##  Privacy First
+
+CommitMind runs entirely on your machine using local models.
+Your source code is never sent to external servers.
+
+---
+
+##  Tech Stack
+
+* Node.js CLI
+* TypeScript
+* Ollama (Local LLM)
+* Conventional commits
+
+---
+
+##  Roadmap
+
+* Interactive commit preview
+* Smart commit type detection
+* Git hooks integration
+* VS Code extension
+* Multi-model support
+* Config file
+* Streaming AI output
+
+---
+
+## Contributing
+
+Contributions are welcome!
+
+1. Fork the repo
+2. Create a feature branch
+3. Submit a pull request
+
+---
+
+##  Support
+
+If you like this project:
+
+*  Star it on GitHub
+* Share with your friends
+* Give feedback
+
+---
+
+##  License
+
+MIT © Nabin Sharma
+
+---
+
+##  Links
+
+* GitHub: https://github.com/Nabin-09/ai-commit-generator
+* Issues: https://github.com/Nabin-09/ai-commit-generator/issues
+
+---
+
+Made with ❤️ for developers.

package/bun.lock

@@ -6,6 +6,7 @@
       "name": "ai-commit-gen",
       "dependencies": {
         "commitmind": "^1.0.0",
+        "readline": "^1.3.0",
       },
       "devDependencies": {
         "@types/node": "^25.3.0",
@@ -18,6 +19,8 @@
 
     "commitmind": ["commitmind@1.0.0", "", { "bin": { "aic": "dist/index.js" } }, "sha512-yxLwQAf4QV8cLAs5ObPoLmf0Qc1mE5v1t0BmD9rCKboSesy2S1ExQp2cngd/4xjPefy6X3SX/ysvlIj+nSXlmA=="],
 
+    "readline": ["readline@1.3.0", "", {}, "sha512-k2d6ACCkiNYz222Fs/iNze30rRJ1iIicW7JuX/7/cozvih6YCkFZH+J6mAFDVgv0dRBaAyr4jDqC95R2y4IADg=="],
+
     "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
 
     "undici-types": ["undici-types@7.18.2", "", {}, "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w=="],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commitmind",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "author": "Nabin Sharma",
   "bin": {
     "aic": "./dist/index.js",
@@ -24,6 +24,7 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "commitmind": "^1.0.0"
+    "commitmind": "^1.0.0",
+    "readline": "^1.3.0"
   }
 }

package/src/config.ts

@@ -0,0 +1,26 @@
+import { existsSync, mkdirSync , readFileSync , writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import path from "node:path";
+
+
+const CONFIG_DIR = path.join(homedir() , '.commitmind')
+const CONFIG_FILE = path.join(CONFIG_DIR , 'config.json')
+
+type Config = {
+    model : string;
+};
+
+export function getConfig() : Config | null{
+    try{
+        if(!existsSync(CONFIG_FILE)) return null;
+        return JSON.parse(readFileSync(CONFIG_FILE , 'utf-8'));
+    }catch(err){
+        return null;
+    }
+}
+export function saveConfig(config: Config) {
+  if (!existsSync(CONFIG_DIR)) {
+    mkdirSync(CONFIG_DIR);
+  }
+  writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));
+}

package/src/index.ts

@@ -2,9 +2,31 @@
 
 import { stageAll, getDiff, commit, push } from "./git.js";
 import { generateCommit } from "./ollama.js";
+import { getConfig , saveConfig } from "./config.js";
+import { selectModel } from "./selectModel.js";
 
+
+async function resolveModel(cliModel?: string): Promise<string> {
+  // 1. CLI flag wins (old users safe)
+  if (cliModel) {
+    saveConfig({ model: cliModel }); 
+    return cliModel;
+  }
+
+
+  const config = getConfig();
+  if (config?.model) return config.model;
+
+  if (!process.stdout.isTTY) {
+    return "llama3.1:latest";
+  }
+
+  console.log("No model configured.");
+  return await selectModel();
+}
 async function main() {
-  const command = process.argv[2];
+  const args = process.argv.slice(2);
+  const command = args[0];
 
   if (!command) {
     console.log(`
@@ -12,6 +34,10 @@ Usage:
 aic auto
 aic push <branch>
 
+Model:
+aic model set
+aic model get
+
 Examples:
 aic auto
 aic push main
@@ -20,24 +46,45 @@ aic push main
   }
 
 
+  if (command === "model") {
+    const sub = args[1];
+
+    if (sub === "set") {
+      await selectModel();
+      return;
+    }
+
+    if (sub === "get") {
+      const config = getConfig();
+      console.log("Current model:", config?.model || "Not set");
+      return;
+    }
+  }
+
+  // -------- model flag --------
+  let cliModel: string | undefined;
+  const modelIndex = args.indexOf("--model");
+  if (modelIndex !== -1 && args[modelIndex + 1]) {
+    cliModel = args[modelIndex + 1];
+  }
+
+  const model = await resolveModel(cliModel);
+
   console.log("📦 Staging changes...");
   await stageAll();
 
   const diff = await getDiff();
 
+  console.log(`Generating commit using ${model}...`);
+  const message = await generateCommit(diff, model);
 
-  console.log(" Generating commit...");
-  const message = await generateCommit(diff);
-
-  console.log("✅ Commit:", message);
-
+  console.log("Commit:", message);
 
   await commit(message);
 
-  
   if (command === "push") {
-    const branch = process.argv[3] || "main";
-    console.log(` Pushing to ${branch}...`);
+    const branch = args[1] || "main";
+    console.log(`Pushing to ${branch}...`);
     await push(branch);
   }
 }

package/src/ollama.ts

@@ -1,8 +1,11 @@
 type OllamaResponse = {
-  response: string;
+    response: string;
 };
 
-export async function generateCommit(diff: string): Promise<string> {
+export async function generateCommit(
+    diff: string,
+    model: string = 'llama3.1:latest'
+): Promise<string> {
     if (!diff) {
         console.log(`No changes done`)
         process.exit(0);
@@ -52,18 +55,25 @@ Now generate the commit message.
 Diff:
 ${diff}
 `
+    try {
+        const res = await fetch('http://localhost:11434/api/generate', {
+            method: 'POST',
+            body: JSON.stringify({
+                model,
+                prompt,
+                stream: false,
+            })
+        })
+    const data = (await res.json()) as OllamaResponse;
+    return data.response.trim();
+    }catch(err){
+        console.log(`Failed to connect to Ollama`);
+        process.exit(1);
+        
+    }
+
+
 
-const res = await fetch('http://localhost:11434/api/generate', {
-    method : 'POST',
-    body : JSON.stringify({
-        model : 'llama3.1:latest',
-        prompt,
-        stream : false,
-    })
-})
-
-const data = await res.json() as OllamaResponse;
-return data.response.trim() ;
 }
 
 

package/src/selectModel.ts

@@ -0,0 +1,46 @@
+
+import { saveConfig } from "./config";
+import readline from "readline";
+
+async function getOllamaModels():Promise<string[]> {
+    try {
+        const res = await fetch('http://localhost:11434/api/tags');
+        const data = await res.json();
+        return data.models.map((m : any)=> m.name)
+    }catch(err){
+        console.log(`Ollama is not running ${err}`)
+        process.exit(1);
+    }
+}
+
+export async function selectModel() : Promise<string>{
+    const models = await getOllamaModels();
+    if(!models.length){
+        console.log(`No Ollama models found ! `);
+        process.exit(1);
+    }
+    console.log('Choose an Ollama model : ');
+    models.forEach((m , i)=> console.log(`${i + 1}.${m}`));
+
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output : process.stdout,
+    })
+
+    const choice = await new Promise<number>((res)=>{
+        rl.question('Enter number : ' , (ans)=>{
+            rl.close();
+            res(Number(ans))
+        })
+    })
+
+    const selected = models[choice - 1];
+    if(!selected){
+        console.log(`Invalid Choice`);
+        process.exit(1);
+    }
+
+    saveConfig({model : selected});
+    console.log(`Model saved : ${selected}`);
+    return selected;
+}