scai 0.1.12 → 0.1.13

package/README.md

@@ -1,41 +1,34 @@
 # ⚙️ scai — Smart Commit AI ✨
 
-> AI-powered CLI tools for smart commit messages, auto generated comments, and readme files — all powered by local models.
+> AI-powered CLI tools for smart commit messages, code comments, summaries, and changelogs — all powered by local models.
 
 **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  
-- ✨ Comments your code automatically
-- 🧠 Get a summary of any code file directly to the terminal 
+- 💬 Suggest high-quality Git commit messages  
+- ✨ Automatically comment your code  
+- 🧠 Summarize code files instantly in the terminal  
+- 📝 Generate changelog entries based on Git diffs  
 - 🔒 100% local — no API keys, no cloud, no telemetry  
 
 ---
 
 ## 🚀 Features
 
-- ⚡️ Powered by open local Ollama models like `mistral` and new `commentModule`
+- ⚡️ Powered by local Ollama models like `llama3` and `codellama`
 - 🛠️ CLI built with Node.js + TypeScript
 - 🔒 No external services, full privacy by design  
-- ✅ Now supports global options for model and language settings
-
-### 📦 Recent Additions
-
-* **Summary Command**: Print a summary of the given file to the terminal (e.g., `scai summ <file>`)
+- ✅ Global options for model and language selection
 
 ---
 
-## ❤️ Philosophy: Why Local AI?
+## ❤️ Why Local AI?
 
 We believe your code — and your workflow — should stay **yours**. scai runs entirely on your machine using open-source models and tools.
 
-No internet connection. No vendor lock-in. Just local, private, AI-enhanced developer experience.
-
 ✅ Works entirely offline  
-✅ No API keys, cloud accounts, or telemetry  
+✅ No API keys or cloud dependencies  
 ✅ Backed by open-source models  
-✅ Designed for CLI-first devs and scriptable workflows  
-
-**scai** follows the Unix philosophy — small, composable tools with powerful output.
+✅ Designed for CLI-first developers
 
 ---
 
@@ -44,28 +37,27 @@ No internet connection. No vendor lock-in. Just local, private, AI-enhanced deve
 1. **Install [Ollama](https://ollama.com)**  
    - On **Windows**: [Download Ollama](https://ollama.com/download)  
    - On **macOS**:  
-     - Install via Homebrew:  
+     - Via Homebrew:  
        ```bash
        brew install ollama
        ```  
-     - Or download directly from the [Ollama website](https://ollama.com/download)  
-   - Ensure it’s added to your system `PATH`
+     - Or download directly from the website
 
-2. **Install scai globally via npm:**
+2. **Install scai globally:**
 
 ```bash
 npm install -g scai
 ```
 
-3. **Run the initialization step to start Ollama and install models:**
+3. **Initialize the tool and 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
+- Start the Ollama background server
+- Download required models (`llama3`, etc.)
 
 ---
 
@@ -74,10 +66,7 @@ This will:
 ### 💬 Suggest a commit message
 
 ```bash
-# Stage your changes
 git add .
-
-# Let scai suggest a commit message
 scai sugg
 ```
 
@@ -86,7 +75,7 @@ scai sugg
 feat(api): add error handling to user service
 ```
 
-To automatically commit with the suggested message:
+To commit automatically with the suggestion:
 
 ```bash
 scai sugg --commit
@@ -94,41 +83,52 @@ scai sugg --commit
 
 ---
 
-### 🛠 Comment a code file
+### ✨ Comment a code file
 
 ```bash
-scai comment <file>
+scai comm <file>
 ```
 
-Write comments for the given file. Optional flags:
-- `-a, --apply` - Apply the refactored version to the original file
+Adds clear, helpful comments to the code. Optional flag:
+- `-a, --apply` — Overwrite the original file with the commented version
 
 ---
 
-### 🔍 Code summary
+### 🔍 Summarize a code file
 
 ```bash
 scai summ <file>
 ```
 
-Create a quick summary of the file your working on to gain fast insights. 
+Prints a summary of what the code does directly to your terminal.
+
+---
+
+### 📝 Update the changelog
+
+```bash
+scai changelog
+```
+
+Analyzes the current Git diff and updates (or creates) a `CHANGELOG.md` file with relevant public-facing changes.
 
 ---
 
 ## 🔐 License & Fair Use
 
-**scai is free to use** for individuals, teams, and companies — including in commercial work.  
+**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  
+- ✅ Use it at work or in commercial development  
+- ✅ Share and recommend it  
 
-However:
+But you may not:
 
-- ❌ You may not **resell**, repackage, or redistribute **scai** as a commercial product or SaaS offering  
-- ❌ You may not claim ownership or original authorship  
+- ❌ Repackage or resell **scai** as a product or SaaS  
+- ❌ Claim ownership of the tool
 
-For full terms, see the [LICENSE](./LICENSE) file.
+See [LICENSE](./LICENSE) for full terms.
 
----
+---

package/dist/commands/ChangeLogUpdateCmd.js

@@ -0,0 +1,39 @@
+// src/commands/handleChangelogUpdate.ts
+import { execSync } from 'child_process';
+import fs from 'fs/promises';
+import path from 'path';
+import { runPromptPipeline } from '../pipeline/runPipeline.js';
+import { changelogModule } from '../pipeline/modules/changeLogModule.js';
+export async function handleChangelogUpdate() {
+    try {
+        let diff = execSync("git diff", { encoding: "utf-8" }).trim();
+        if (!diff) {
+            diff = execSync("git diff --cached", { encoding: "utf-8" }).trim();
+        }
+        if (!diff) {
+            console.log("⚠️  No staged or unstaged changes to include in changelog.");
+            return;
+        }
+        const result = await runPromptPipeline([changelogModule], { code: diff });
+        if (!result.code.trim()) {
+            console.log("✅ No significant changes for changelog.");
+            return;
+        }
+        const root = execSync("git rev-parse --show-toplevel", { encoding: "utf-8" }).trim();
+        const changelogPath = path.join(root, "CHANGELOG.md");
+        let existing = "";
+        try {
+            existing = await fs.readFile(changelogPath, "utf-8");
+        }
+        catch {
+            console.log("📄 Creating new CHANGELOG.md");
+        }
+        const today = new Date().toISOString().split("T")[0];
+        const newEntry = `\n\n## ${today}\n\n${result.code}`;
+        await fs.writeFile(changelogPath, existing + newEntry, "utf-8");
+        console.log("📝 CHANGELOG.md updated.");
+    }
+    catch (err) {
+        console.error("❌ Failed to update changelog:", err.message);
+    }
+}

package/dist/commands/CommitSuggesterCmd.js

@@ -3,11 +3,12 @@ import readline from 'readline';
 function askUserToChoose(suggestions) {
     return new Promise((resolve) => {
         console.log('\n💡 AI-suggested commit messages:\n');
-        suggestions.forEach((msg, i) => {
+        suggestions.slice(0, 3).forEach((msg, i) => {
             console.log(`${i + 1}) ${msg}`);
         });
-        console.log(`${suggestions.length + 1}) 🔁 Regenerate suggestions`);
-        console.log(`${suggestions.length + 2}) ✍️  Write your own commit message`);
+        console.log('\n---');
+        console.log('4) 🔁 Regenerate suggestions');
+        console.log('5) ✍️  Write your own commit message');
         const rl = readline.createInterface({
             input: process.stdin,
             output: process.stdout,

package/dist/commands/SummaryCmd.js

@@ -1,12 +1,36 @@
-// File: src/commands/SummaryCmd.ts
 import fs from 'fs/promises';
 import { summaryModule } from '../pipeline/modules/summaryModule.js';
+import readline from 'readline';
 export async function summarizeFile(filepath) {
-    try {
-        const code = await fs.readFile(filepath, 'utf-8');
+    let code = '';
+    if (filepath) {
+        try {
+            code = await fs.readFile(filepath, 'utf-8');
+        }
+        catch (err) {
+            console.error(`❌ Could not read or summarize ${filepath}:`, err.message);
+            return;
+        }
+    }
+    // ⬇️ Add this check right here
+    else if (process.stdin.isTTY) {
+        console.error('❌ No file provided and no piped input.\n👉 Usage: scai summ <file> or cat file | scai summ');
+        return;
+    }
+    else {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+            terminal: false,
+        });
+        for await (const line of rl) {
+            code += line + '\n';
+        }
+    }
+    if (code.trim()) {
         await summaryModule.run({ code });
     }
-    catch (err) {
-        console.error(`❌ Could not read or summarize ${filepath}:`, err.message);
+    else {
+        console.error('❌ No code provided to summarize.');
     }
 }

package/dist/config/ModelConfig.js

@@ -1,16 +1,23 @@
 export class ModelConfig {
     static setModel(model) {
         this.model = model;
+        console.log(`📦 Model set to: ${model}`);
     }
     static getModel() {
         return this.model;
     }
     static setLanguage(lang) {
         this.language = lang;
+        console.log(`🗣️ Language set to: ${lang}`);
     }
     static getLanguage() {
         return this.language;
     }
+    static logCurrentConfig() {
+        console.log(`🔧 Current configuration:`);
+        console.log(`   Model   : ${this.model}`);
+        console.log(`   Language: ${this.language}`);
+    }
 }
 ModelConfig.model = 'codellama:7b';
 ModelConfig.language = 'ts';

package/dist/index.js

@@ -7,11 +7,11 @@ 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 { generateTests } from "./commands/TestGenCmd.js";
 import { bootstrap } from './modelSetup.js';
 import { ModelConfig } from './config/ModelConfig.js';
 import { summarizeFile } from "./commands/SummaryCmd.js";
+import { handleChangelogUpdate } from './commands/ChangeLogUpdateCmd.js';
 // Create the CLI instance
 const cmd = new Command('scai')
     .version(version)
@@ -36,11 +36,13 @@ cmd
     .option('-a, --apply', 'Apply the refactored version to the original file')
     .action((file, options) => handleRefactor(file, options));
 cmd
-    .command('readme')
-    .description('Update README.md if relevant changes were made')
-    .action(updateReadmeIfNeeded);
+    .command('changelog')
+    .description('Update or create the CHANGELOG.md based on current Git diff')
+    .action(async () => {
+    await handleChangelogUpdate();
+});
 cmd
-    .command('summ <file>')
+    .command('summ [file]')
     .description('Print a summary of the given file to the terminal')
     .action((file) => summarizeFile(file));
 cmd
@@ -55,6 +57,12 @@ cmd
     .command('gen-tests <file>')
     .description('Generate a Jest test file for the specified JS/TS module')
     .action((file) => generateTests(file));
+cmd
+    .command('config')
+    .description('Show the currently active model and language settings')
+    .action(() => {
+    ModelConfig.logCurrentConfig();
+});
 // ✅ Now that commands are defined, parse args
 cmd.parse(process.argv);
 // ✅ Apply global options after parsing

package/dist/pipeline/modules/changeLogModule.js

@@ -0,0 +1,30 @@
+import { ModelConfig } from '../../config/ModelConfig.js';
+export const changelogModule = {
+    name: 'changelogModule',
+    description: 'Generates changelog entry based on Git diff',
+    async run(input) {
+        const model = ModelConfig.getModel();
+        const prompt = `
+You're an experienced changelog writer. Based on this Git diff, write a markdown bullet-point entry suitable for CHANGELOG.md:
+
+--- DIFF START ---
+${input.code}
+--- DIFF END ---
+
+✅ If the changes are significant, return a changelog entry.
+❌ If not, return ONLY: "NO UPDATE".
+    `.trim();
+        const res = await fetch('http://localhost:11434/api/generate', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                model,
+                prompt,
+                stream: false,
+            }),
+        });
+        const data = await res.json();
+        const output = data.response?.trim() ?? '';
+        return { code: output === 'NO UPDATE' ? '' : output };
+    },
+};

package/dist/pipeline/modules/commentModule.js

@@ -6,11 +6,16 @@ export const addCommentsModule = {
         const model = ModelConfig.getModel();
         const lang = ModelConfig.getLanguage();
         const prompt = `
-You are a senior ${lang.toUpperCase()} engineer.
+You are a senior ${lang.toUpperCase()} engineer reviewing source code.
 
-Add clear and helpful single-line // comments to complex parts of the code.
-- Do NOT remove or change in ANY way any parts of the code!
-- Output ALL of the original code with your comments included
+Your task is to add clear and helpful single-line // comments to complex or non-obvious parts of the code.
+
+⚠️ VERY IMPORTANT RULES:
+- You MUST return the ENTIRE original code.
+- You MUST NOT remove, replace, reformat, or alter ANY code.
+- Only add single-line // comments in appropriate places.
+- Do NOT wrap the code in markdown or code blocks.
+- The code should be valid ${lang.toUpperCase()} after your changes.
 
 --- CODE START ---
 ${input.code}

package/dist/pipeline/modules/summaryModule.js

@@ -8,15 +8,20 @@ export const summaryModule = {
         const prompt = `
 You are a senior ${lang.toUpperCase()} engineer.
 
-Analyze the code below and return a concise summary of its functionality or structure. 
-Only return the summary in this format:
+Take the following source code and do NOT modify it in any way. Your task is:
+
+1. Output the original code exactly as it is.
+2. After the code, append a short summary in this format:
 
 // Summary of code:
-// - [Bullet 1]
-// - [Bullet 2]
-// - etc.
+// - [What the code does at a high level]
+// - [Main features or components]
+// - [Any interesting logic or patterns]
 
-Return the original code after the summary.
+⚠️ IMPORTANT:
+- Do NOT omit or alter any part of the original code.
+- Do NOT insert comments inside the code.
+- Only append the summary AFTER the full code.
 
 --- CODE START ---
 ${code}

package/package.json

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

package/dist/commands/CommitSuggesterCmd.refactored.js

@@ -1,106 +0,0 @@
-import { execSync } from 'child_process';
-import readline from 'readline';
-async function askUserToChoose(suggestions) {
-    return new Promise((resolve) => {
-        console.log('\n💡 AI-suggested commit messages:\n'); // Display all suggestions to the user
-        suggestions.forEach((msg, i) => {
-            console.log(`${i + 1}) ${msg}`);
-        });
-        console.log(`${suggestions.length + 1}) 🔁 Regenerate suggestions`); // Allow the user to regenerate suggestions if they want
-        console.log(`${suggestions.length + 2}) ✍️  Write your own commit message`); // Allow the user to write their own commit message
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-        rl.question(`\n👉 Choose a commit message [1-${suggestions.length + 2}]: `, // Ask the user to choose from the suggestions or write their own
-        (answer) => {
-            rl.close();
-            const choice = parseInt(answer, 10); // Parse the user's input as a number
-            if (isNaN(choice) || choice < 1 || choice > suggestions.length + 2) { // Check that the user has entered a valid number
-                console.log('⚠️  Invalid selection. Using the first suggestion by default.'); // Default to the first suggestion if the input is invalid
-                resolve(0); // Resolve the promise with the 0-based index (0 to 3)
-            }
-            else if (choice === suggestions.length + 2) { // If the user has chosen "Write your own commit message"
-                resolve('custom'); // Return 'custom' to indicate that the user wants to write their own commit message
-            }
-            else {
-                resolve(choice - 1); // Return the 0-based index (0 to 3) of the selected suggestion
-            }
-        });
-    });
-}
-async function generateSuggestions(prompt) {
-    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(); // Parse the response from the API as JSON
-    if (!response || typeof response !== 'string') { // Check that the response is valid
-        throw new Error('Invalid LLM response'); // Throw an error if the response is invalid
-    }
-    const lines = response.trim().split('\n').filter(line => /^\d+\.\s+/.test(line)); // Split the response into individual lines and filter out any lines that don't start with a number followed by a period
-    const messages = lines.map(line => // Map each line to its commit message suggestion
-     line.replace(/^\d+\.\s+/, '').replace(/^"(.*)"$/, '$1').trim());
-    if (messages.length === 0) { // Check that there are any commit message suggestions
-        throw new Error('No valid commit messages found in LLM response.'); // Throw an error if there are no valid commit message suggestions
-    }
-    return messages; // Return the array of commit message suggestions
-}
-function promptCustomMessage() {
-    return new Promise((resolve) => {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-        rl.question('\n📝 Enter your custom commit message:\n> ', (input) => {
-            rl.close();
-            resolve(input.trim()); // Resolve the promise with the trimmed input string
-        });
-    });
-}
-export async function suggestCommitMessage(options) {
-    try {
-        let diff = execSync("git diff", { encoding: "utf-8" }).trim(); // Get the current Git diff
-        if (!diff) { // Check that there are any changes to stage
-            diff = execSync("git diff --cached", { encoding: "utf-8" }).trim(); // If there are no staged changes, check for unstaged changes
-        }
-        if (!diff) { // If there are still no changes, display a message and return early
-            console.log('⚠️  No staged changes to suggest a message for.');
-            return;
-        }
-        const prompt = `Suggest 3 concise, conventional Git commit message options for this diff. Return ONLY the commit messages, numbered 1 to 3, like so:
-1. ...
-2. ...
-3. ...
-
-Here is the diff:
-${diff}`; // Create a prompt string for the user to enter their own commit message suggestions
-        let message = null;
-        while (message === null) { // Loop until the user has entered a valid commit message or chosen to write their own
-            const suggestions = await generateSuggestions(prompt); // Generate commit message suggestions based on the diff output from Git
-            const choice = await askUserToChoose(suggestions); // Ask the user to choose from the suggestions or write their own
-            if (choice === 'custom') { // If the user has chosen "Write your own commit message"
-                message = await promptCustomMessage(); // Prompt the user for their custom commit message
-                break; // Break out of the loop and use the custom commit message
-            }
-            message = suggestions[choice]; // Use the selected suggestion as the commit message
-        }
-        console.log(`\n✅ Selected commit message:\n${message}\n`); // Display the selected commit message to the user
-        if (options.commit) { // If the user has specified that they want to commit the changes
-            const commitDiff = execSync("git diff", { encoding: "utf-8" }).trim(); // Get the current Git diff again, in case anything has changed since the last call to `generateSuggestions`
-            if (commitDiff) { // Check that there are any staged changes
-                execSync("git add .", { encoding: "utf-8" }); // Stage all changes before committing
-            }
-            execSync(`git commit -m "${message.replace(/"/g, '\\"')}"`, { stdio: 'inherit' }); // Commit the changes with the selected commit message
-            console.log('✅ Committed with selected message.'); // Display a success message to the user
-        }
-    }
-    catch (err) { // If there is an error in the code
-        console.error('❌ Error in commit message suggestion:', err); // Log the error to the console
-    }
-}

package/dist/commands/EnvCmd.test.js

@@ -1,146 +0,0 @@
-"use strict";
-Here;
-'s a Jest test file for the `checkEnv` function: `` `typescript
-import { checkEnv } from "../src/utils";
-
-describe("checkEnv", () => {
-  it("should warn when missing required env vars", () => {
-    const processEnv = Object.assign({}, process.env);
-    delete processEnv.DB_HOST;
-    delete processEnv.API_KEY;
-    const consoleWarnSpy = jest.spyOn(console, "warn").mockImplementation();
-    checkEnv();
-    expect(consoleWarnSpy).toHaveBeenCalledWith("❌ Missing env vars: DB_HOST, API_KEY");
-    consoleWarnSpy.mockRestore();
-  });
-
-  it("should log a message when all required env vars are set", () => {
-    const processEnv = Object.assign({}, process.env);
-    checkEnv();
-    expect(console.log).toHaveBeenCalledWith("✅ All env vars are set");
-  });
-});
-` ``;
-In;
-this;
-test;
-file, we;
-first;
-var the = ;
-`checkEnv`;
-function from() { }
-the;
-contains;
-it.We;
-then;
-define;
-two;
-test;
-cases: one;
-for (when; required; environment)
-    variables;
-are;
-missing;
-and;
-another;
-for (when; all; required)
-    environment;
-variables;
-are;
-set.
-;
-In;
-the;
-first;
-test;
-we;
-use `jest.spyOn()`;
-to;
-mock;
-the `console.warn()`;
-method;
-and;
-replace;
-it;
-with (a)
-    spy;
-function () { }
-We;
-then;
-delete the `DB_HOST`;
-and `API_KEY`;
-environment;
-variables;
-and;
-call;
-the `checkEnv()`;
-function () { }
-Finally, we;
-check;
-that;
-the `console.warn()`;
-method;
-was;
-called;
-with (the)
-    expected;
-message.
-;
-In;
-the;
-second;
-test;
-we;
-simply;
-call;
-the `checkEnv()`;
-function without() { }
-deleting;
-any;
-environment;
-variables;
-and;
-check;
-that;
-the `console.log()`;
-method;
-was;
-called;
-with (the)
-    expected;
-message.
-;
-Note;
-that;
-we;
-use;
-the `mockImplementation()`;
-method;
-to;
-mock;
-the `console.warn()`;
-method;
-and;
-the `mockRestore()`;
-method;
-to;
-restore;
-it;
-after;
-the;
-test;
-is;
-done.This;
-is;
-necessary;
-because;
-Jest;
-does;
-not;
-allow;
-us;
-to;
-modify;
-the;
-original `console.warn()`;
-method.;

package/dist/commands/ReadmeCmd.js

@@ -1,61 +0,0 @@
-import { execSync } from 'child_process';
-import fs from 'fs/promises';
-import path from 'path';
-export async function updateReadmeIfNeeded() {
-    try {
-        let diff = execSync("git diff", { encoding: "utf-8" }).trim();
-        if (!diff) {
-            diff = execSync("git diff --cached", { encoding: "utf-8" }).trim();
-        }
-        if (!diff) {
-            console.log('⚠️  No staged changes to suggest a message for.');
-            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);
-    }
-}