scai 0.1.11 → 0.1.12

package/README.md

@@ -1,25 +1,26 @@
 # ⚙️ scai — Smart Commit AI ✨
 
-> AI-powered CLI tools for smart commit messages, automated refactoring, and developer insight — all powered by local models.
+> AI-powered CLI tools for smart commit messages, auto generated comments, and readme files — 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
-- 🧠 Generate README updates based on your diff  
+- 🧠 Get a summary of any code file directly to the terminal 
 - 🔒 100% local — no API keys, no cloud, no telemetry  
 
 ---
 
-**scai** follows the Unix philosophy — small, composable tools with powerful output.
-
 ## 🚀 Features
 
-- 💬 Generate commit messages from staged Git changes  
-- ✨ Add comments to your code 
-- ⚡️ Powered by open local Ollama models like `mistral`  
-- 🛠️ CLI built with Node.js + TypeScript  
+- ⚡️ Powered by open local Ollama models like `mistral` and new `commentModule`
+- 🛠️ 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>`)
 
 ---
 
@@ -34,6 +35,8 @@ No internet connection. No vendor lock-in. Just local, private, AI-enhanced deve
 ✅ Backed by open-source models  
 ✅ Designed for CLI-first devs and scriptable workflows  
 
+**scai** follows the Unix philosophy — small, composable tools with powerful output.
+
 ---
 
 ## 📦 Installation
@@ -75,7 +78,7 @@ This will:
 git add .
 
 # Let scai suggest a commit message
-scai suggest
+scai sugg
 ```
 
 > Example output:
@@ -86,42 +89,29 @@ feat(api): add error handling to user service
 To automatically commit with the suggested message:
 
 ```bash
-scai suggest --commit
+scai sugg --commit
 ```
 
 ---
 
-### 🛠 Refactor a JavaScript file
+### 🛠 Comment a code file
 
 ```bash
-scai refac path/to/file.js
+scai comment <file>
 ```
 
-A cleaned-up version will be written to:
-
-```
-path/to/refactored/file.refactored.js
-```
+Write comments for the given file. Optional flags:
+- `-a, --apply` - Apply the refactored version to the original file
 
 ---
 
-### 🧩 Generate Tests
+### 🔍 Code summary
 
 ```bash
-scai generate-tests <file>
+scai summ <file>
 ```
 
-Automatically generates Jest test files for specified JavaScript/TypeScript modules.
-
----
-
-### 🔍 Check Git status
-
-```bash
-scai git
-```
-
-Useful overview of current branch, commits, and uncommitted changes.
+Create a quick summary of the file your working on to gain fast insights. 
 
 ---
 
@@ -141,4 +131,4 @@ However:
 
 For full terms, see the [LICENSE](./LICENSE) file.
 
----
+---

package/dist/commands/CommitSuggesterCmd.refactored.js

@@ -1,41 +1,35 @@
-// Import required modules
 import { execSync } from 'child_process';
 import readline from 'readline';
-// Function to ask the user to choose a commit message suggestion
 async function askUserToChoose(suggestions) {
-    // Create an interface for reading and writing to the console
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-    // Show AI-suggested commit messages to the user and ask for their choice
     return new Promise((resolve) => {
-        console.log('\n💡 AI-suggested commit messages:\n');
+        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`);
-        console.log(`${suggestions.length + 2}) ✍️  Write your own commit message`);
-        rl.question(`\n👉 Choose a commit message [1-${suggestions.length + 2}]: `, (answer) => {
-            // Close the readline interface and resolve the promise with user choice
+        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);
-            if (isNaN(choice) || choice < 1 || choice > suggestions.length + 2) {
-                console.log('⚠️  Invalid selection. Using the first suggestion by default.');
-                resolve(0);
+            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) {
-                resolve('custom');
+            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 0-based index (0 to 3)
+                resolve(choice - 1); // Return the 0-based index (0 to 3) of the selected suggestion
             }
         });
     });
 }
-// Async function to generate commit message suggestions using an API call
 async function generateSuggestions(prompt) {
-    // Fetch the suggestions from an API and return them as an array of strings
     const res = await fetch("http://localhost:11434/api/generate", {
         method: "POST",
         headers: { "Content-Type": "application/json" },
@@ -45,17 +39,19 @@ async function generateSuggestions(prompt) {
             stream: false,
         }),
     });
-    const { response } = await res.json();
-    // Check for validity of the LLM response and return an array of commit messages
-    if (!response || typeof response !== 'string') {
-        throw new Error('Invalid LLM response');
+    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
     }
-    const lines = response.trim().split('\n').filter(line => /^\d+\.\s+/.test(line));
-    return lines.map(line => line.replace(/^\d+\.\s+/, '').replace(/^"(.*)"$/, '$1').trim());
+    return messages; // Return the array of commit message suggestions
 }
-// Function to prompt the user for a custom commit message
-async function promptCustomMessage() {
-    // Read the user's input for their custom commit message
+function promptCustomMessage() {
     return new Promise((resolve) => {
         const rl = readline.createInterface({
             input: process.stdin,
@@ -63,18 +59,17 @@ async function promptCustomMessage() {
         });
         rl.question('\n📝 Enter your custom commit message:\n> ', (input) => {
             rl.close();
-            resolve(input.trim());
+            resolve(input.trim()); // Resolve the promise with the trimmed input string
         });
     });
 }
-// Export the main function to suggest a commit message based on user input and generated suggestions
 export async function suggestCommitMessage(options) {
     try {
-        let diff = execSync("git diff", { encoding: "utf-8" }).trim();
-        if (!diff) {
-            diff = execSync("git diff --cached", { encoding: "utf-8" }).trim();
+        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 (!diff) { // If there are still no changes, display a message and return early
             console.log('⚠️  No staged changes to suggest a message for.');
             return;
         }
@@ -84,33 +79,28 @@ export async function suggestCommitMessage(options) {
 3. ...
 
 Here is the diff:
-${diff}`;
+${diff}`; // Create a prompt string for the user to enter their own commit message suggestions
         let message = null;
-        while (message === null) {
-            const suggestions = await generateSuggestions(prompt);
-            const choice = await askUserToChoose(suggestions);
-            if (choice === suggestions.length) {
-                // User chose "Regenerate"
-                console.log('\n🔄 Regenerating suggestions...\n');
-                continue;
-            }
-            if (choice === 'custom') {
-                message = await promptCustomMessage();
-                break;
+        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];
+            message = suggestions[choice]; // Use the selected suggestion as the commit message
         }
-        console.log(`\n✅ Selected commit message:\n${message}\n`);
-        if (options.commit) {
-            const commitDiff = execSync("git diff", { encoding: "utf-8" }).trim();
-            if (commitDiff) {
-                execSync("git add .", { encoding: "utf-8" });
+        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' });
-            console.log('✅ Committed with selected message.');
+            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) {
-        console.error('❌ Error in commit message suggestion:', err.message);
+    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

@@ -0,0 +1,146 @@
+"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/SummaryCmd.js

@@ -0,0 +1,12 @@
+// File: src/commands/SummaryCmd.ts
+import fs from 'fs/promises';
+import { summaryModule } from '../pipeline/modules/summaryModule.js';
+export async function summarizeFile(filepath) {
+    try {
+        const code = await fs.readFile(filepath, 'utf-8');
+        await summaryModule.run({ code });
+    }
+    catch (err) {
+        console.error(`❌ Could not read or summarize ${filepath}:`, err.message);
+    }
+}

package/dist/config/ModelConfig.js

@@ -0,0 +1,16 @@
+export class ModelConfig {
+    static setModel(model) {
+        this.model = model;
+    }
+    static getModel() {
+        return this.model;
+    }
+    static setLanguage(lang) {
+        this.language = lang;
+    }
+    static getLanguage() {
+        return this.language;
+    }
+}
+ModelConfig.model = 'codellama:7b';
+ModelConfig.language = 'ts';

package/dist/index.js

@@ -1,16 +1,22 @@
 #!/usr/bin/env node
 import { Command } from "commander";
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const { version } = require('../package.json');
 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 the model check and initialization logic
 import { bootstrap } from './modelSetup.js';
+import { ModelConfig } from './config/ModelConfig.js';
+import { summarizeFile } from "./commands/SummaryCmd.js";
 // Create the CLI instance
 const cmd = new Command('scai')
-    .version('0.1.0');
+    .version(version)
+    .option('--model <model>', 'Set the model to use (e.g., codellama:34b)')
+    .option('--lang <lang>', 'Set the target language (ts, java, rust)');
 // Define CLI commands
 cmd
     .command('init')
@@ -20,21 +26,13 @@ cmd
     console.log('✅ Model initialization completed!');
 });
 cmd
-    .command('env')
-    .description('Check environment variables')
-    .action(checkEnv);
-cmd
-    .command('git')
-    .description('Check Git status')
-    .action(checkGit);
-cmd
-    .command('suggest')
+    .command('sugg')
     .description('Suggest a commit message from staged changes')
     .option('-c, --commit', 'Automatically commit with suggested message')
     .action(suggestCommitMessage);
 cmd
-    .command('refac <file>')
-    .description('Suggest a refactor for the given JS/TS file')
+    .command('comm <file>')
+    .description('Write comments for the given file')
     .option('-a, --apply', 'Apply the refactored version to the original file')
     .action((file, options) => handleRefactor(file, options));
 cmd
@@ -42,8 +40,26 @@ cmd
     .description('Update README.md if relevant changes were made')
     .action(updateReadmeIfNeeded);
 cmd
-    .command('generate-tests <file>')
+    .command('summ <file>')
+    .description('Print a summary of the given file to the terminal')
+    .action((file) => summarizeFile(file));
+cmd
+    .command('git')
+    .description('Check Git status')
+    .action(checkGit);
+cmd
+    .command('env')
+    .description('Check environment variables')
+    .action(checkEnv);
+cmd
+    .command('gen-tests <file>')
     .description('Generate a Jest test file for the specified JS/TS module')
     .action((file) => generateTests(file));
-// Parse CLI arguments
+// ✅ Now that commands are defined, parse args
 cmd.parse(process.argv);
+// ✅ Apply global options after parsing
+const opts = cmd.opts();
+if (opts.model)
+    ModelConfig.setModel(opts.model);
+if (opts.lang)
+    ModelConfig.setLanguage(opts.lang);

package/dist/pipeline/modules/commentModule.js

@@ -1,9 +1,12 @@
+import { ModelConfig } from '../../config/ModelConfig.js';
 export const addCommentsModule = {
     name: 'addComments',
     description: 'Adds meaningful // comments to each block of code',
     async run(input) {
+        const model = ModelConfig.getModel();
+        const lang = ModelConfig.getLanguage();
         const prompt = `
-You are a senior JavaScript engineer. 
+You are a senior ${lang.toUpperCase()} engineer.
 
 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!
@@ -17,8 +20,8 @@ ${input.code}
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
             body: JSON.stringify({
-                model: 'mistral',
-                prompt: prompt,
+                model,
+                prompt,
                 stream: false,
             }),
         });

package/dist/pipeline/modules/generateTestsModule.js

@@ -1,11 +1,14 @@
 import fs from 'fs/promises';
 import path from 'path';
+import { ModelConfig } from '../../config/ModelConfig.js';
 export const generateTestsModule = {
     name: 'generateTests',
     description: 'Generate a Jest test file for the class/module',
     async run({ code, filepath }) {
+        const model = ModelConfig.getModel();
+        const lang = ModelConfig.getLanguage();
         const prompt = `
-You're a senior TypeScript developer. Given the following class or module, generate a Jest test file.
+You are a senior ${lang.toUpperCase()} engineer. Given the following class or module, generate a Jest test file.
 
 Guidelines:
 - Use the 'jest' test framework
@@ -21,7 +24,7 @@ ${code}
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
             body: JSON.stringify({
-                model: 'mistral',
+                model,
                 prompt,
                 stream: false
             })

package/dist/pipeline/modules/refactorModule.js

@@ -1,25 +1,45 @@
+import { ModelConfig } from '../../config/ModelConfig.js';
 export const refactorModule = {
     name: 'refactor',
     description: 'Break code into small, clean functions',
-    async run({ code }) {
+    async run(input) {
+        const model = ModelConfig.getModel();
+        const lang = ModelConfig.getLanguage();
         const prompt = `
-You are a senior JavaScript/TypeScript engineer.
+You are a senior ${lang.toUpperCase()} engineer.
 
 Refactor the following code:
-- Refactor only long and complex functions 
+- Refactor only long and complex functions
 - Keep original names and semantics.
 - Do NOT insert comments
 
 --- CODE START ---
-${code}
+${input.code}
 --- CODE END ---
 `.trim();
-        const res = await fetch('http://localhost:11434/api/generate', {
-            method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
-            body: JSON.stringify({ model: 'mistral', prompt: prompt, stream: false })
-        });
-        const data = await res.json();
-        return { code: data.response?.trim() ?? '' };
+        try {
+            const res = await fetch('http://localhost:11434/api/generate', {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json' },
+                body: JSON.stringify({
+                    model,
+                    prompt,
+                    stream: false
+                })
+            });
+            if (!res.ok) {
+                const errBody = await res.text();
+                throw new Error(`❌ Refactor failed: ${res.status} ${res.statusText} - ${errBody}`);
+            }
+            const data = await res.json();
+            if (!data.response) {
+                throw new Error('❌ No response field returned from model.');
+            }
+            return { code: data.response.trim() };
+        }
+        catch (err) {
+            console.error('🔥 Error in refactorModule:', err);
+            throw new Error('❌ Error in refactor module: ' + err.message);
+        }
     }
 };

package/dist/pipeline/modules/summaryModule.js

@@ -1,20 +1,22 @@
+import { ModelConfig } from '../../config/ModelConfig.js';
 export const summaryModule = {
     name: 'summary',
-    description: 'Append // Summary of changes at the end',
+    description: 'Prints a summary of changes to the terminal',
     async run({ code }) {
+        const model = ModelConfig.getModel();
+        const lang = ModelConfig.getLanguage();
         const prompt = `
-You are a senior developer assistant.
+You are a senior ${lang.toUpperCase()} engineer.
 
-Take the following code and return it exactly as-is, 
-but add a summary at the very end in this format:
+Analyze the code below and return a concise summary of its functionality or structure. 
+Only return the summary in this format:
 
-// Summary of refactor:
-// - Did X
-// - Did Y
+// Summary of code:
+// - [Bullet 1]
+// - [Bullet 2]
 // - etc.
 
-DO NOT modify or omit any existing code. 
-Just append the summary.
+Return the original code after the summary.
 
 --- CODE START ---
 ${code}
@@ -23,9 +25,18 @@ ${code}
         const res = await fetch('http://localhost:11434/api/generate', {
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
-            body: JSON.stringify({ model: 'llama3', prompt: prompt, stream: false })
+            body: JSON.stringify({ model, prompt, stream: false })
         });
         const data = await res.json();
-        return { code: data.response?.trim() ?? '' };
+        const summary = data.response?.trim();
+        if (summary) {
+            console.log('\n📝 Code Summary:\n');
+            console.log(summary);
+        }
+        else {
+            console.warn('⚠️ No summary generated.');
+        }
+        // Return unchanged input so it’s pipe-safe, if reused in pipelines
+        return { code };
     }
 };

package/package.json

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