scai 0.1.5 → 0.1.6

package/README.md

@@ -1,29 +1,120 @@
-# scai — Smart Commit AI ✨
+# ⚙️ scai — Smart Commit AI ✨
 
-> AI-powered commit message suggestions from staged changes — directly in your terminal.
+> AI-powered CLI tools for smart commit messages, automated refactoring, and developer insight — all powered by local models.
 
-**scai** (Smart Commit AI) is a lightweight, privacy-focused CLI tool that uses a local AI model to generate clear, meaningful commit messages based on your staged Git changes. No internet required. No telemetry. Just smart commits.
+**scai** (Smart Commit AI) is a lightweight, privacy-focused CLI tool that uses local AI models (via [Ollama](https://ollama.com)) to help developers work faster and cleaner:
+
+- 🤖 Suggest high-quality Git commit messages  
+- ✨ Refactor messy code files  
+- 🧠 Check Git status and improve workflows  
+- 🔒 100% local — no API keys, no cloud, no telemetry  
 
 ---
 
 ## 🚀 Features
 
-- 🔍 Automatically suggests commit messages based on `git diff`
-- 🤖 Uses a local language model via [Ollama](https://ollama.com/) — no external API keys
-- 🧱 Designed for local developer workflows and automation
-- 📦 Works with any Git repository
+- 💬 Generate commit messages from staged Git changes  
+- ✨ Refactor a single JavaScript file for improved readability  
+- 🔍 Check Git status with one command  
+- ⚡️ Powered by Ollama + local models like `llama3` and `mistral`  
+- 🛠️ CLI built with Node.js + TypeScript  
+- 🔒 No external services, full privacy by design  
 
 ---
 
 ## 📦 Installation
 
-You'll need [Ollama](https://ollama.com/) installed and running locally, with a supported model like `mistral` pulled:
+1. **Install [Ollama](https://ollama.com)**  
+   - On Windows: [Download Ollama](https://ollama.com/download)  
+   - Ensure it’s added to your system `PATH`
+
+2. **Install scai globally via npm:**
+
+```bash
+npm install -g scai
+```
+
+3. **Run the initialization step to start Ollama and install models:**
+
+```bash
+scai init
+```
+
+This will:
+- Launch the Ollama background server (if not running)
+- Pull the required models (`llama3`, `mistral`) if they aren’t present
+
+---
+
+## 🧪 Usage Examples
+
+### 💬 Suggest a commit message
+
+```bash
+# Stage your changes
+git add .
+
+# Let scai suggest a commit message
+scai commit
+```
+
+> Example output:
+```
+feat(api): add error handling to user service
+```
+
+To automatically commit with the suggested message:
+
+```bash
+scai commit --commit
+```
+
+---
+
+### 🛠 Refactor a JavaScript file
+
+```bash
+scai refactor path/to/file.js
+```
+
+A cleaned-up version will be written to:
+
+```
+path/to/refactored/file.refactored.js
+```
+
+---
+
+### 🔍 Check Git status
 
 ```bash
-ollama run mistral
+scai git
+```
+
+Useful overview of current branch, commits, and uncommitted changes.
+
+---
+
+## 🔐 License & Fair Use
+
+**scai is free to use** for individuals, teams, and companies — including in commercial work.  
+You may:
+
+- ✅ Use it internally in your projects  
+- ✅ Use it at work or in commercial software development  
+- ✅ Share and recommend it to colleagues  
+
+However:
+
+- ❌ You may not **resell**, repackage, or redistribute **scai** as a commercial product or SaaS offering  
+- ❌ You may not claim ownership or original authorship  
+
+For full terms, see the [LICENSE](./LICENSE) file.
+
+---
 
+## ❤️ Why Local-First?
 
-## License
+We believe your code — and your workflow — should stay **yours**. scai runs entirely on your machine using open-source models and tools.
 
-This software is licensed for non-commercial use only.
-See the [LICENSE](./LICENSE) file for details.
+No internet connection. No vendor lock-in. Just local, private, AI-enhanced developer experience.

package/dist/commands/ReadmeCmd.js

@@ -0,0 +1,58 @@
+import { execSync } from 'child_process';
+import fs from 'fs/promises';
+import path from 'path';
+export async function updateReadmeIfNeeded() {
+    try {
+        const diff = execSync("git diff", { encoding: "utf-8" }).trim();
+        if (!diff) {
+            console.log("⚠️ No changes to analyze in the working directory.");
+            return;
+        }
+        const readmePath = path.resolve("README.md");
+        let readme = "";
+        try {
+            readme = await fs.readFile(readmePath, "utf-8");
+        }
+        catch {
+            console.log("📄 No existing README.md found, skipping update.");
+            return;
+        }
+        const prompt = `
+You're an experienced documentation writer. Here's the current README:
+
+--- README START ---
+${readme}
+--- README END ---
+
+Here is a Git diff of recent code changes:
+
+--- DIFF START ---
+${diff}
+--- DIFF END ---
+
+✅ If the changes are significant and relevant to the public-facing documentation, return an updated README.  
+❌ If they are not, return ONLY: "NO UPDATE".
+`;
+        const res = await fetch("http://localhost:11434/api/generate", {
+            method: "POST",
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify({
+                model: "llama3",
+                prompt,
+                stream: false,
+            }),
+        });
+        const { response } = await res.json();
+        const result = response.trim();
+        if (result === "NO UPDATE") {
+            console.log("✅ No significant changes for README.");
+        }
+        else {
+            await fs.writeFile(readmePath, result, "utf-8");
+            console.log("📝 README.md updated based on significant changes.");
+        }
+    }
+    catch (err) {
+        console.error("❌ Failed to update README:", err.message);
+    }
+}

package/dist/index.js

@@ -4,6 +4,7 @@ import { checkEnv } from "./commands/EnvCmd.js";
 import { checkGit } from "./commands/GitCmd.js";
 import { suggestCommitMessage } from "./commands/CommitSuggesterCmd.js";
 import { handleRefactor } from "./commands/RefactorCmd.js";
+import { updateReadmeIfNeeded } from "./commands/ReadmeCmd.js";
 // Import the model check and initialization logic
 import { bootstrap } from './modelSetup.js';
 // Create the CLI instance
@@ -34,5 +35,9 @@ cmd
     .command('refactor <file>')
     .description('Suggest a refactor for the given JS file')
     .action((file) => handleRefactor(file));
+cmd
+    .command('readme')
+    .description('Update README.md if relevant changes were made')
+    .action(updateReadmeIfNeeded);
 // Parse CLI arguments
 cmd.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "type": "module",
   "bin": {
     "scai": "./dist/index.js"