commitmind 1.0.0 → 1.0.2

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

@@ -4,6 +4,9 @@
   "workspaces": {
     "": {
       "name": "ai-commit-gen",
+      "dependencies": {
+        "commitmind": "^1.0.0",
+      },
       "devDependencies": {
         "@types/node": "^25.3.0",
         "typescript": "^5.9.3",
@@ -13,6 +16,8 @@
   "packages": {
     "@types/node": ["@types/node@25.3.0", "", { "dependencies": { "undici-types": "~7.18.0" } }, "sha512-4K3bqJpXpqfg2XKGK9bpDTc6xO/xoUP/RBWS7AtRMug6zZFaRekiLzjVtAoZMquxoAbzBvy5nxQ7veS5eYzf8A=="],
 
+    "commitmind": ["commitmind@1.0.0", "", { "bin": { "aic": "dist/index.js" } }, "sha512-yxLwQAf4QV8cLAs5ObPoLmf0Qc1mE5v1t0BmD9rCKboSesy2S1ExQp2cngd/4xjPefy6X3SX/ysvlIj+nSXlmA=="],
+
     "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,12 +1,19 @@
 {
   "name": "commitmind",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "author": "Nabin Sharma",
   "bin": {
-    "aic": "./dist/index.js"
+    "aic": "./dist/index.js",
+    "cm": "./dist/index.js"
   },
   "description": "AI-powered Git commit CLI using Ollama",
-  "keywords": ["git", "ai", "commit", "ollama", "cli"],
+  "keywords": [
+    "git",
+    "ai",
+    "commit",
+    "ollama",
+    "cli"
+  ],
   "license": "MIT",
   "scripts": {
     "build": "tsc"
@@ -15,5 +22,8 @@
   "devDependencies": {
     "@types/node": "^25.3.0",
     "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "commitmind": "^1.0.0"
   }
-}
+}