scai 0.1.81 → 0.1.83

package/dist/CHANGELOG.md

@@ -0,0 +1,102 @@
+## 2025-06-23
+
+The new markdown bullet-point entry for CHANGELOG.md includes the following updates:
+
+* Added support for generating changelog entries based on Git diffs using the `changelog` command.
+* Updated the summary of the code file directly to the terminal using the `summ` command.
+* Refactored the code to use the new `handleChangelogUpdate()` function instead of the old `updateReadmeIfNeeded()` function for generating changelogs.
+
+## 2025-06-24
+
+### Changelog Update (Version 0.1.16)
+
+* Update to version 0.1.16 with changes from `package.json`.
+* Add support for running modules using the `module` command.
+* Add support for generating tests using the `tests` module.
+* Add support for suggesting a commit message using the `suggest` module.
+* Add support for updating the changelog using the `changelog` module.
+
+
+## 2025-06-29
+Type handling with the module pipeline
+┌────────────────────────────────────────────────────────────────┐
+│  1. Command Layer (CLI)                                        │
+│  - User interaction                                            │
+│  - Handles input/output                                        │
+│                                                                │
+│  🡆 Uses:                                                      │
+│     - Input:  PromptInput                                      │
+│     - Output: PromptOutput (reads summary/suggestions)         │
+└────────────┬───────────────────────────────────────────────────┘
+             │
+             ▼
+┌────────────────────────────────────────────────────────────────┐
+│  2. PromptModule Layer                                         │
+│  - Domain-specific logic                                       │
+│  - Calls `generate()`                                          │
+│  - Parses model output into usable fields                      │
+│                                                                │
+│  🡆 Type: PromptModule                                         │
+│     - run(input: PromptInput) => Promise<PromptOutput>         │
+│                                                                │
+│  🡆 Uses:                                                      │
+│     - Receives: PromptInput                                    │
+│     - Calls: generate(PromptInput, model): Promise<PromptOutput>│
+│     - Parses output.content → summary/suggestions fields       │
+└────────────┬───────────────────────────────────────────────────┘
+             │
+             ▼
+┌────────────────────────────────────────────────────────────────┐
+│  3. generate() Function                                        │
+│  - Sends prompt to model                                       │
+│  - Returns raw model text in `.content`                        │
+│                                                                │
+│  🡆 Signature:                                                  │
+│     generate(input: PromptInput, model: string)                │
+│       => Promise<PromptOutput>                                 │
+│                                                                │
+│  🡆 Output fields:                                             │
+│     - content: string (LLM output text)                        │
+│     - filepath?: string (optional passthrough)                │
+└────────────────────────────────────────────────────────────────┘
+
+
+
+## 2025-06-30
+
+* Added context generation via summaries in sqlite3 db with FTS5
+* Improved the `dbstats.sh` script to include more accurate row counts and improved formatting for better readability. (#20)
+* Added an `IGNORED_FOLDER_GLOBS` constant in `src/config/IgnoredPaths.ts` to allow for ignoring folders and file globs during indexing and scanning. (#17)
+* Fixed a bug in the `searchFiles` function of `src/db/fileIndex.ts` that prevented search results from being returned correctly. (#25)
+* Updated the `runModulePipeline` function in `src/pipeline/runModulePipeline.ts` to allow for returning more accurate output and ensure consistent return types. (#27)
+
+## 2025-07-01
+
+### Version 0.1.20 (2023-04-01)
+* Added support for querying file summaries and a local model using the `scai ask` command. The command will first search for matching files and pass their summaries to the model for context-based synthesis, if any are found. If no summaries are found, it will instead query the model for context without them.
+
+
+## 2025-07-12
+
+* • Fixes to improve code quality and maintainability.
+* • Enhances model initialization for better performance.
+* • Adds support for generating changelogs based on Git diff.
+* • Improves the handling of ignored files to reduce noise in the model.
+* • Updates the `changelog` command to generate a meaningful summary.
+* • Enhances the `sugg` command to provide more accurate suggestions.
+* • Fixes issues with refactoring code to improve readability.
+
+## 2025-07-24
+
+* Added token and owner/repo parameters to `getPullRequestsForReview` function
+* Updated `askUserToPickPR` function to accept a list of PR objects
+* Removed unnecessary code from `reviewPullRequestCmd`
+* Added `cancel` option to `askReviewApproval` function
+
+## 2025-08-10
+
+• Removed versioned dist folder 
+• Update .gitignore to ignore Node and build artifacts, editor/IDE files, and project-specific ignores.
+• Added scripts for building cli, server, and dashboard
+• Restructure the workspace into 3 modules, cli, dashboard, server
+• Improved `askChangelogApproval` to support editing and skipping of changelog entries

package/dist/commands/ChangeLogUpdateCmd.js

@@ -5,16 +5,10 @@ import path from 'path';
 import { runModulePipeline } from '../pipeline/runModulePipeline.js';
 import { changelogModule } from '../pipeline/modules/changeLogModule.js';
 import { askChangelogApproval } from '../utils/changeLogPrompt.js';
+import { openTextEditor } from '../utils/editor.js';
 export async function handleStandaloneChangelogUpdate() {
-    let diff = execSync("git diff", { encoding: "utf-8", stdio: "pipe" }).trim();
-    if (!diff) {
-        diff = execSync("git diff --cached", { encoding: "utf-8", stdio: "pipe" }).trim();
-    }
-    if (!diff) {
-        console.log('⚠️ No changes detected for changelog.');
-        return;
-    }
-    let entry = await generateChangelogEntry(diff);
+    // Don't bother with diffs at all here
+    let entry = await generateChangelogEntry();
     if (!entry) {
         console.log('⚠️ No significant changes found.');
         return;
@@ -28,7 +22,7 @@ export async function handleStandaloneChangelogUpdate() {
         }
         else if (userChoice === 'redo') {
             console.log('🔁 Regenerating changelog...');
-            entry = await generateChangelogEntry(diff);
+            entry = await generateChangelogEntry();
             if (!entry) {
                 console.log('⚠️ Could not regenerate entry. Exiting.');
                 break;
@@ -40,26 +34,26 @@ export async function handleStandaloneChangelogUpdate() {
         }
     }
 }
-export async function generateChangelogEntry(diff) {
+export async function generateChangelogEntry(currentCommitMsg) {
     try {
-        // If no diff is provided, fetch the current diff from git silently
-        if (!diff) {
-            diff = execSync("git diff", { encoding: "utf-8", stdio: 'pipe' }).trim();
-            // If no unstaged changes, fall back to staged changes
-            if (!diff) {
-                diff = execSync("git diff --cached", { encoding: "utf-8", stdio: 'pipe' }).trim();
-            }
+        const lastTag = getLastGitTag();
+        if (!lastTag) {
+            console.log("⚠️ No previous git tag found. Using all commits.");
         }
-        if (!diff) {
-            // No changes found, auto cancel by returning null
-            console.log('⚠️ No changes detected for the changelog.');
+        let commits = lastTag
+            ? getCommitsSinceTag(lastTag)
+            : execSync('git log --pretty=format:%s', { encoding: 'utf-8' }).trim();
+        if (currentCommitMsg) {
+            commits = commits ? `${commits}\n${currentCommitMsg}` : currentCommitMsg;
+        }
+        console.log('Number of commits:', commits.split('\n').length);
+        if (!commits) {
+            console.log("⚠️ No commits found since last release.");
             return null;
         }
-        // Generate the changelog entry using the diff silently
-        const result = await runModulePipeline([changelogModule], { content: diff });
+        const result = await runModulePipeline([changelogModule], { content: commits });
         const output = result?.summary?.trim();
         if (!output || output === 'NO UPDATE') {
-            // Auto-cancel if no update
             console.log('⚠️ No significant changes detected for changelog.');
             return null;
         }
@@ -70,6 +64,18 @@ export async function generateChangelogEntry(diff) {
         return null;
     }
 }
+function getLastGitTag() {
+    try {
+        return execSync('git describe --tags --abbrev=0', { encoding: 'utf-8' }).trim();
+    }
+    catch {
+        return null; // no tags found
+    }
+}
+function getCommitsSinceTag(tag) {
+    // Get commit messages in a simple format, e.g. only commit messages
+    return execSync(`git log ${tag}..HEAD --pretty=format:%s`, { encoding: 'utf-8' }).trim();
+}
 export async function updateChangelogFile(entry) {
     const root = execSync("git rev-parse --show-toplevel", { encoding: "utf-8" }).trim();
     const changelogPath = path.join(root, "CHANGELOG.md");
@@ -85,3 +91,38 @@ export async function updateChangelogFile(entry) {
     await fs.writeFile(changelogPath, existing + newEntry, 'utf-8');
     return changelogPath;
 }
+export async function handleChangelogWithCommitMessage(commitMsg) {
+    let entryFinalized = false;
+    let changelogEntry = await generateChangelogEntry(commitMsg);
+    if (!changelogEntry) {
+        console.log("ℹ️ No changelog entry generated.");
+        return;
+    }
+    while (!entryFinalized) {
+        const userChoice = await askChangelogApproval(changelogEntry);
+        if (userChoice === 'yes') {
+            const changelogPath = await updateChangelogFile(changelogEntry);
+            execSync(`git add "${changelogPath}"`);
+            console.log("✅ CHANGELOG.md staged.");
+            entryFinalized = true;
+        }
+        else if (userChoice === 'redo') {
+            console.log("🔁 Regenerating changelog entry...");
+            changelogEntry = await generateChangelogEntry(commitMsg);
+            if (!changelogEntry) {
+                console.log('⚠️ Could not regenerate entry. Exiting.');
+                break;
+            }
+        }
+        else if (userChoice === 'edit') {
+            changelogEntry = await openTextEditor(changelogEntry, 'scai-changelog.txt');
+            if (!changelogEntry) {
+                console.log('⚠️ No changes made to changelog. Returning to prompt.');
+            }
+        }
+        else {
+            console.log("❌ Skipped changelog update.");
+            entryFinalized = true;
+        }
+    }
+}

package/dist/commands/CommitSuggesterCmd.js

@@ -2,23 +2,28 @@
 import { execSync } from 'child_process';
 import readline from 'readline';
 import { commitSuggesterModule } from '../pipeline/modules/commitSuggesterModule.js';
-import { generateChangelogEntry, updateChangelogFile } from './ChangeLogUpdateCmd.js';
-import { askChangelogApproval } from '../utils/changeLogPrompt.js';
+import { handleChangelogWithCommitMessage } from './ChangeLogUpdateCmd.js';
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { spawnSync } from 'child_process';
+import chalk from 'chalk';
 function askUserToChoose(suggestions) {
     return new Promise((resolve) => {
         console.log('\n💡 AI-suggested commit messages:\n');
         suggestions.forEach((msg, i) => {
-            console.log(`${i + 1}) ${msg}`);
+            console.log(`${i + 1}) ${chalk.hex('#FFA500')(`\`${msg}\``)}`);
         });
         console.log('\n---');
         console.log(`${suggestions.length + 1}) 🔁 Regenerate suggestions`);
         console.log(`${suggestions.length + 2}) ✍️  Write your own commit message`);
-        console.log(`${suggestions.length + 3}) ❌ Cancel`);
+        console.log(`${suggestions.length + 3}) 🖋️ Edit a suggested commit message`);
+        console.log(`${suggestions.length + 4}) ❌ Cancel`);
         const rl = readline.createInterface({
             input: process.stdin,
             output: process.stdout,
         });
-        rl.question(`\n👉 Choose a commit message [1-${suggestions.length + 3}]: `, (answer) => {
+        rl.question(`\n👉 Choose a commit message [1-${suggestions.length + 4}]: `, (answer) => {
             rl.close();
             const choice = parseInt(answer, 10);
             if (choice === suggestions.length + 1) {
@@ -28,6 +33,9 @@ function askUserToChoose(suggestions) {
                 resolve('custom');
             }
             else if (choice === suggestions.length + 3) {
+                resolve('edit');
+            }
+            else if (choice === suggestions.length + 4) {
                 resolve('cancel');
             }
             else if (!isNaN(choice) && choice >= 1 && choice <= suggestions.length) {
@@ -40,6 +48,46 @@ function askUserToChoose(suggestions) {
         });
     });
 }
+async function promptEditCommitMessage(suggestedMessage) {
+    const tmpFilePath = path.join(os.tmpdir(), 'scai-commit-msg.txt');
+    fs.writeFileSync(tmpFilePath, `# Edit your commit message below.\n# Lines starting with '#' will be ignored.\n\n${suggestedMessage}`);
+    const editor = process.env.EDITOR || (process.platform === 'win32' ? 'notepad' : 'vi');
+    spawnSync(editor, [tmpFilePath], { stdio: 'inherit' });
+    const editedContent = fs.readFileSync(tmpFilePath, 'utf-8');
+    return editedContent
+        .split('\n')
+        .filter(line => !line.trim().startsWith('#'))
+        .join('\n')
+        .trim() || suggestedMessage;
+}
+function askWhichSuggestionToEdit(suggestions) {
+    return new Promise((resolve) => {
+        console.log('\n🖋️ Select a commit message to edit:\n');
+        suggestions.forEach((msg, i) => {
+            console.log(`${i + 1}) ${chalk.hex('#FFA500')(`\`${msg}\``)}`);
+        });
+        console.log(`${suggestions.length + 1}) ❌ Cancel`);
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        const editPrompt = chalk.magenta(`\n👉 Choose a commit message to edit [1-${suggestions.length + 1}]: `);
+        rl.question(editPrompt, (answer) => {
+            rl.close();
+            const choice = parseInt(answer, 10);
+            if (!isNaN(choice) && choice >= 1 && choice <= suggestions.length) {
+                resolve(choice - 1);
+            }
+            else if (choice === suggestions.length + 1) {
+                resolve('cancel');
+            }
+            else {
+                console.log('⚠️ Invalid selection.');
+                resolve('cancel');
+            }
+        });
+    });
+}
 function promptCustomMessage() {
     return new Promise((resolve) => {
         const rl = readline.createInterface({
@@ -53,42 +101,15 @@ function promptCustomMessage() {
     });
 }
 export async function suggestCommitMessage(options) {
-    // Ensure git diff does not print to console
     try {
-        let diff = execSync("git diff", { encoding: "utf-8", stdio: "pipe" }).trim();
+        let diff = execSync("git diff --cached", { encoding: "utf-8", stdio: "pipe" }).trim();
         if (!diff) {
-            diff = execSync("git diff --cached", { encoding: "utf-8", stdio: "pipe" }).trim();
+            diff = execSync("git diff", { encoding: "utf-8", stdio: "pipe" }).trim();
         }
         if (!diff) {
-            console.log('⚠️  No staged changes to suggest a message for.');
+            console.log('⚠️ No staged changes to suggest a message for.');
             return;
         }
-        // Handle changelog generation if the flag is provided
-        if (options.changelog) {
-            let entryFinalized = false;
-            while (!entryFinalized) {
-                const changelogEntry = await generateChangelogEntry(diff);
-                if (!changelogEntry) {
-                    console.log("ℹ️ No changelog entry generated.");
-                    break;
-                }
-                const userChoice = await askChangelogApproval(changelogEntry);
-                if (userChoice === 'yes') {
-                    const changelogPath = await updateChangelogFile(changelogEntry);
-                    execSync(`git add "${changelogPath}"`);
-                    console.log("✅ CHANGELOG.md staged.");
-                    entryFinalized = true;
-                }
-                else if (userChoice === 'redo') {
-                    console.log("🔁 Regenerating changelog entry...");
-                    continue; // Loop again and regenerate
-                }
-                else {
-                    console.log("❌ Skipped changelog update.");
-                    entryFinalized = true;
-                }
-            }
-        }
         // Continue with commit suggestions
         const response = await commitSuggesterModule.run({ content: diff });
         const suggestions = response.suggestions || [];
@@ -108,6 +129,17 @@ export async function suggestCommitMessage(options) {
             if (choice === 'custom') {
                 message = await promptCustomMessage();
             }
+            else if (choice === 'edit') {
+                // Ask which suggestion to edit using a dedicated prompt
+                const editChoice = await askWhichSuggestionToEdit(suggestions);
+                if (typeof editChoice === 'number') {
+                    message = await promptEditCommitMessage(suggestions[editChoice]);
+                }
+                else {
+                    console.log('⚠️ Edit cancelled, returning to main menu.');
+                    continue;
+                }
+            }
             else if (choice === 'cancel') {
                 console.log('❌ Commit cancelled.');
                 return;
@@ -117,6 +149,10 @@ export async function suggestCommitMessage(options) {
             }
         }
         console.log(`\n✅ Selected commit message:\n${message}\n`);
+        // If changelog option is enabled, generate changelog including the selected commit message
+        if (options.changelog) {
+            await handleChangelogWithCommitMessage(message);
+        }
         const staged = execSync("git diff --cached", { encoding: "utf-8" }).trim();
         if (!staged) {
             console.log("⚠️ No files are currently staged for commit.");

package/dist/commands/RefactorCmd.js

@@ -2,7 +2,6 @@ import fs from 'fs/promises';
 import path from 'path';
 import { runModulePipeline } from '../pipeline/runModulePipeline.js';
 import { addCommentsModule } from '../pipeline/modules/commentModule.js';
-import { cleanupModule } from '../pipeline/modules/cleanupModule.js';
 export async function handleRefactor(filepath, options = {}) {
     try {
         // Normalize path: add ./ prefix if no directory specified
@@ -27,7 +26,7 @@ export async function handleRefactor(filepath, options = {}) {
         // Read source code
         const content = await fs.readFile(filepath, 'utf-8');
         // Run through pipeline modules
-        const response = await runModulePipeline([addCommentsModule, cleanupModule], { content });
+        const response = await runModulePipeline([addCommentsModule], { content });
         if (!response.content.trim())
             throw new Error('⚠️ Model returned empty result');
         // Save refactored output

package/dist/commands/ReviewCmd.js

@@ -85,11 +85,21 @@ function askUserToPickPR(prs) {
         const rows = prs.map((pr, i) => ({
             '#': i + 1,
             ID: `#${pr.number}`,
-            Title: truncate(pr.title, 50),
-            Author: pr.user || '—',
+            Title: chalk.gray(truncate(pr.title, 50)),
+            Author: chalk.magentaBright(pr.user || '—'),
             Status: pr.draft ? 'Draft' : 'Open',
             Created: pr.created_at?.split('T')[0] || '',
-            Reviewers: pr.requested_reviewers?.map(r => r.login).join(', ') || '—',
+            'Requested Reviewers': pr.requested_reviewers?.length
+                ? pr.requested_reviewers.join(', ')
+                : chalk.gray('—'),
+            'Actual Reviewers': pr.reviewers?.length
+                ? chalk.cyan(pr.reviewers.join(', '))
+                : chalk.gray('—'),
+            Reviews: pr.review_status === 'Approved'
+                ? chalk.green('Approved')
+                : pr.review_status === 'Changes Requested'
+                    ? chalk.red('Changes Requested')
+                    : chalk.gray('—'),
         }));
         console.log(chalk.blue("\n📦 Open Pull Requests:"));
         console.log(columnify(rows, {
@@ -97,7 +107,9 @@ function askUserToPickPR(prs) {
             headingTransform: (h) => chalk.cyan(h.toUpperCase()),
             config: {
                 Title: { maxWidth: 50 },
-                Reviewers: { maxWidth: 30 }
+                'Requested Reviewers': { maxWidth: 30 },
+                'Actual Reviewers': { maxWidth: 30 },
+                Reviews: { maxWidth: 20 },
             }
         }));
         const rl = readline.createInterface({ input: process.stdin, output: process.stdout });

package/dist/github/github.js

@@ -12,16 +12,45 @@ export async function fetchOpenPullRequests(token, owner, repo) {
         throw new Error(`GitHub API error: ${res.status} ${res.statusText}`);
     }
     const prs = await res.json();
-    return prs.map((pr) => ({
-        number: pr.number,
-        title: pr.title,
-        url: pr.url,
-        diff_url: pr.diff_url,
-        draft: pr.draft,
-        merged_at: pr.merged_at,
-        base: pr.base,
-        requested_reviewers: pr.requested_reviewers,
+    const augmentedPRs = await Promise.all(prs.map(async (pr) => {
+        const reviewsRes = await fetch(`${pr.url}/reviews`, {
+            headers: {
+                Authorization: `token ${token}`,
+                Accept: 'application/vnd.github.v3+json',
+            }
+        });
+        let latestState = '—';
+        let reviewers = [];
+        if (reviewsRes.ok) {
+            const reviews = await reviewsRes.json();
+            const latestPerUser = new Map();
+            for (const review of reviews) {
+                latestPerUser.set(review.user.login, review.state);
+            }
+            reviewers = [...latestPerUser.keys()]; // ✅ actual reviewers
+            if ([...latestPerUser.values()].includes('CHANGES_REQUESTED')) {
+                latestState = 'Changes Requested';
+            }
+            else if ([...latestPerUser.values()].includes('APPROVED')) {
+                latestState = 'Approved';
+            }
+        }
+        return {
+            number: pr.number,
+            title: pr.title,
+            url: pr.url,
+            diff_url: pr.diff_url,
+            draft: pr.draft,
+            merged_at: pr.merged_at,
+            base: pr.base,
+            user: pr.user?.login || 'unknown',
+            created_at: pr.created_at,
+            requested_reviewers: pr.requested_reviewers?.map((r) => r.login) || [],
+            reviewers,
+            review_status: latestState,
+        };
     }));
+    return augmentedPRs;
 }
 export async function getGitHubUsername(token) {
     const res = await fetch('https://api.github.com/user', {

package/dist/github/repo.js

@@ -17,7 +17,7 @@ function getRepoOwnerAndNameFromGit(indexDir) {
     try {
         const originUrl = runGitCommand('git config --get remote.origin.url', indexDir);
         console.log(`🔗 Git origin URL from '${indexDir}': ${originUrl}`);
-        const match = originUrl.match(/github\.com[:/](.+?)(?:\.git)?$/);
+        const match = originUrl.match(/github[^:/]*[:/](.+?)(?:\.git)?$/);
         if (!match)
             throw new Error("❌ Could not parse GitHub repo from origin URL.");
         const [owner, repo] = match[1].split('/');

package/dist/lib/generate.js

@@ -1,6 +1,14 @@
 // File: lib/generate.ts
 import { Spinner } from './spinner.js';
+import { readConfig } from '../config.js';
 export async function generate(input, model) {
+    const contextLength = readConfig().contextLength ?? 8192;
+    let prompt = input.content;
+    if (prompt.length > contextLength) {
+        console.warn(`⚠️ Warning: Input prompt length (${prompt.length}) exceeds model context length (${contextLength}). ` +
+            `The model may truncate or not handle the entire prompt. Truncating input.`);
+        prompt = prompt.slice(0, contextLength);
+    }
     const spinner = new Spinner(`🧠 Thinking with ${model}...`);
     spinner.start();
     try {
@@ -9,7 +17,7 @@ export async function generate(input, model) {
             headers: { 'Content-Type': 'application/json' },
             body: JSON.stringify({
                 model,
-                prompt: input.content,
+                prompt, // use truncated prompt here
                 stream: false,
             }),
         });

package/dist/pipeline/modules/commentModule.js

@@ -1,26 +1,57 @@
 import { Config } from '../../config.js';
 import { generate } from '../../lib/generate.js';
+import { detectFileType } from '../../fileRules/detectFileType.js';
 export const addCommentsModule = {
     name: 'addComments',
-    description: 'Adds meaningful // comments to each block of code',
+    description: 'Adds meaningful comments to any file type (code, config, or data)',
     async run(input) {
         const model = Config.getModel();
-        const lang = Config.getLanguage();
+        const fileType = detectFileType(input.filepath || '');
+        // Map file types to valid comment syntax
+        const commentMap = {
+            javascript: '//',
+            typescript: '//',
+            java: '//',
+            rust: '//',
+            c: '//',
+            cpp: '//',
+            csharp: '//',
+            go: '//',
+            swift: '//',
+            kotlin: '//',
+            scala: '//',
+            python: '#',
+            ruby: '#',
+            php: '//',
+            shell: '#',
+            bash: '#',
+            config: '#',
+            yaml: '#',
+            markdown: '<!-- -->',
+            html: '<!-- -->',
+            xml: '<!-- -->',
+            json: '/* */',
+            sql: '--',
+            csv: '#',
+            tsv: '#',
+            text: '#',
+        };
+        const commentSyntax = commentMap[fileType] || '//';
         const prompt = `
-You are a senior ${lang.toUpperCase()} engineer reviewing source code.
+You are a senior engineer reviewing a ${fileType} file.
 
-Your task is to add clear and insightful single-line comments to the code.
+Your task is to add clear, helpful, and accurate comments using "${commentSyntax}" syntax.
+This applies to *every* section where an explanation could help — even for simple code or configuration.
 
-⚠️ 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 to complex or non-obvious parts of the code.
-- Do NOT wrap the code in markdown or code blocks.
-- The code should be valid ${lang.toUpperCase()} after your changes.
+Rules:
+- Always return the full original file with comments added.
+- Preserve all formatting, whitespace, and code exactly.
+- Use only "${commentSyntax}" comments that are valid for ${fileType}.
+- Do not wrap the output in markdown or code fences.
 
---- CODE START ---
+--- FILE START ---
 ${input.content}
---- CODE END ---
+--- FILE END ---
 `.trim();
         const response = await generate({ content: prompt }, model);
         return { content: response.content === 'NO UPDATE' ? '' : response.content };

package/dist/utils/changeLogPrompt.js

@@ -1,28 +1,32 @@
 // src/utils/changelogPrompt.ts
+import chalk from 'chalk';
 import readline from 'readline';
-export async function askChangelogApproval(entry) {
+export async function askChangelogApproval(changelogEntry) {
     return new Promise((resolve) => {
-        console.log('\n📜 Proposed changelog entry:\n');
-        console.log(entry);
         console.log('\n---');
-        console.log('1) ✅ Accept and stage');
+        console.log(chalk.yellow('Suggested changelog entry:\n'));
+        console.log(changelogEntry);
+        console.log('\nOptions:');
+        console.log('1) ✅ Accept');
         console.log('2) 🔁 Regenerate');
-        console.log('3) ❌ Skip changelog');
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-        rl.question('\n👉 Choose an option [1-3]: ', (answer) => {
+        console.log('3) 🖋️ Edit');
+        console.log('4) ❌ Skip');
+        const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+        rl.question('\n👉 Choose an option [1-4]: ', (answer) => {
             rl.close();
-            switch (answer.trim()) {
+            switch (answer) {
                 case '1':
                     resolve('yes');
                     break;
                 case '2':
                     resolve('redo');
                     break;
+                case '3':
+                    resolve('edit');
+                    break;
+                case '4':
                 default:
-                    resolve('no');
+                    resolve('skip');
                     break;
             }
         });

package/dist/utils/editor.js

@@ -0,0 +1,16 @@
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { spawnSync } from 'child_process';
+export async function openTextEditor(initialContent, filename) {
+    const tmpFilePath = path.join(os.tmpdir(), filename);
+    fs.writeFileSync(tmpFilePath, initialContent, 'utf-8');
+    const editor = process.env.EDITOR || (process.platform === 'win32' ? 'notepad' : 'vi');
+    spawnSync(editor, [tmpFilePath], { stdio: 'inherit' });
+    const editedContent = fs.readFileSync(tmpFilePath, 'utf-8');
+    return editedContent
+        .split('\n')
+        .filter(line => !line.trim().startsWith('#'))
+        .join('\n')
+        .trim();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.81",
+  "version": "0.1.83",
   "type": "module",
   "bin": {
     "scai": "./dist/index.js"
@@ -52,7 +52,7 @@
     "@types/better-sqlite3": "^7.6.13",
     "@types/columnify": "^1.5.4",
     "@types/jest": "^30.0.0",
-    "@types/node": "^24.1.0",
+    "@types/node": "^24.2.1",
     "@types/proper-lockfile": "^4.1.4",
     "jest": "^30.0.2",
     "ts-jest": "^29.4.0",

package/LICENSE

@@ -1,4 +0,0 @@
-Free for personal and internal company use only.
-Commercial use (resale, SaaS, inclusion in paid tools) is prohibited.
-Contact me for commercial licensing.
-

package/README.md

@@ -1,445 +0,0 @@
-# ⚙️ scai — Smart Commit AI ✨
-
-> AI-powered CLI tool for commit messages **and** pull request reviews — using local models.
-
-**scai** is your AI pair‑programmer in the terminal. Focus on coding while scai:
-
-- 🤖 **Reviews open pull requests** and provides AI‑driven feedback (BETA)  
-- 💬 **Suggests intelligent Git commit messages** based on your staged diff  
-- 📝 Summarizes files in plain English  
-- 📜 Auto‑updates your changelog  
-- 🔍 (ALPHA) Search & ask questions across your codebase  
-- 🔐 100% local — no API keys, no cloud, no telemetry  
-
----
-
-## 🚀 Features
-
-- ⚡ Powered by open-source models (e.g. `llama3`, `codellama`)  
-- 🔍 Full-text indexing & semantic search (ALPHA)  
-- 🛠️ Built with Node.js and TypeScript  
-- ✅ Easily configurable via CLI or global flags  
-
----
-
-## ❤️ Why Local AI?
-
-**Your code stays yours.**  
-scai runs entirely on your machine and doesn't require cloud APIs or API keys. That means:
-
-- ✅ **Privacy-first**: no telemetry, no server round-trips  
-- ✅ **EU & GDPR-friendly**: designed with compliance in mind  
-- ✅ **Developer control**: full transparency and override options  
-- ✅ **Offline support**: works even without an internet connection  
-
----
-
-## 📦 Installation
-
-1. **Install Ollama (for local models)**  
-   - macOS: `brew install ollama`  
-   - Windows: [Download here](https://ollama.com/download)  
-   - Start Ollama after installing.
-
-2. **Install scai globally:**  
-   ```bash
-   npm install -g scai
-    ```
-
-3. **Initialize models:**
-
-   ```bash
-   scai init
-   ```
-
-## ✨ AI Code Review, Powered by Your Terminal
-
-No more struggling to write pull request descriptions by hand. `scai git review` automatically generates a rich summary of your changes, complete with context, suggestions, and rationale.
-
-> ⚠️ These features are in **beta** — feedback welcome!
-Ping [@ticcr](https://bsky.app/profile/ticcr.xyz) on Bluesky — I'd love to hear your thoughts!
-
----
-
-### 🔑 Setting Up Authentication (Required)
-
-To interact with GitHub and create pull requests, `scai` needs a personal access token with **repo** permissions.
-
-1. **Create your GitHub Access Token**
-   Follow this link to generate a token: [https://github.com/settings/personal-access-tokens](https://github.com/settings/personal-access-tokens)
-
-   Make sure you enable at least:
-
-   * `repo` (Full control of private repositories)
-   * `workflow` (If you want PRs to trigger CI)
-
-2. **Set the token in scai:**
-
-   ```bash
-   scai auth set
-   ```
-
-   This stores your token locally in a secure config file. You can inspect the setup at any time:
-
-   ```bash
-   scai auth check
-   ```
-
-3. **Set the index dir:**
-
-   ```bash
-   scai index set /path/to/repo
-   ```
-
-   This is the repo from which scai will look up pull requests that can be reviewed. 
-
----
-## ⚒️ Usage Overview
-### 🧠 How to Use `scai git review`
-
-```bash
-scai git review
-```
-
-This will show you pull requests assigned to you for review:
-
-* Understand the diffs using a local model
-* Generate a structured pull request:
-
-  * ✅ Title
-  * ✅ Summary of changes
-  * ✅ Explanation of why the changes matter
-  * ✅ Optional changelog bullets
-
-
-SCAI supports an integrated review flow for GitHub pull requests. To get started:
-
-1. **Set your working index directory (once per repo):**
-
-   ```sh
-   scai index set /path/to/repo
-   ```
-
-2. **Authenticate with GitHub:**
-   ```sh
-   scai git review
-   ```
-
-   This command will query you for the Personal Access Token and set it for you. 
-   You may also do this with the auth commands below
-
-   ```sh
-   scai auth set
-   scai auth check
-   ```
-
-3. **Fetch and review pull requests:**
-
-   ```sh
-   scai git review
-   ```
-
-   Use `-a` to list all PRs that require a review:
-
-   ```sh
-   scai git review -a
-   ```
-
-#### Example Workflow
-
-```sh
-$ scai git review -a
-🔍 Fetching pull requests and diffs...
-📦 Resolving GitHub repo info from indexDir: ./
-🔗 Git origin URL: git@github.com:org/repo.git
-✅ Parsed: owner='org', repo='repo'
-👤 Authenticated user: username
-
-📦 Open Pull Requests with review requested:
-1) #123 - Fix login timeout bug
-2) #122 - Upgrade dependencies
-
-👉 Choose a PR to review [1-2]: 1
-✅ Model response received.
-
-💡 AI-suggested review:
-
-Solid improvement — this patch improves session stability and handles async state more reliably. 
-You might consider renaming `sessionManager` to better reflect its dual role in auth and persistence.
-
----
-1) ✅ Approve
-2) ❌ Reject
-3) ✍️ Edit
-4) Write your own review
-5) 🚪 Cancel
-```
-
-
-
-### 🔧  How to Use `scai git commit`
-
-Use AI to suggest a meaningful commit message based on your staged code:
-
-```bash
-git add .
-scai git commit
-```
-
-You can also include a changelog entry along with the commit:
-
-```bash
-scai git commit --changelog
-```
-
-This will:
-1. Suggest a commit message based on your `git diff --cached`
-2. Propose a changelog entry (if relevant)
-3. Allow you to approve, regenerate, or skip the changelog
-4. Automatically stage and commit the changes
-
----
-
-### 📝 Generate a Standalone Changelog Entry
-
-If you want to generate a changelog entry without committing:
-
-```bash
-scai gen changelog
-```
-
-This will:
-- Analyze the current `git diff` (staged or unstaged)
-- Propose a list of **user-facing changes** in clean markdown bullet points
-- Let you accept, regenerate, or skip the update
-- Append the entry to `CHANGELOG.md` and stage it if accepted
-
-
-### 🛠️ Code Generation Commands (`gen` group)
-
-```bash
-scai gen summ <file>
-scai gen comm <file>
-scai gen changelog
-scai gen tests <file>
-```
-
-* `summ`: Summarize a file
-* `comm`: Add comments to a file
-* `changelog`: Update or create `CHANGELOG.md` from Git diff
-* `tests`: Create Jest test stubs (ALPHA)
-
-You can also pipe file content directly:
-
-```bash
-cat src/utils/math.ts | scai gen summ
-```
-
----
-
-## ⚙️ Configuration
-
-scai stores settings in `~/.scai/config.json`. You can override or view them:
-
-* **Set model:**
-
-  ```bash
-  scai set model codellama:7b
-  ```
-* **Set language:**
-
-  ```bash
-  scai set lang ts
-  ```
-* **Show config:**
-
-  ```bash
-  scai config
-  ```
-
-<br>
-
-## 🔁 Background Daemon and Indexing ⚠️ ALPHA Notice
-
-These features are experimental and subject to change:
-
-* `index`, `find`, `ask`
-* `daemon`, `stop-daemon`
-* `gen tests` (test generation)
-
-<br>
-
-## Commands
-
-### `index`
-The `index` command is used to manage and perform operations on the indexed files and repositories.
-
-#### `scai index start`
-
-Index supported files in the configured index directory.
-
-```bash
-scai index set <dir>
-```
-
-Set and activate the index directory.
-```bash
-scai index list
-```
-
-List all indexed repositories.
-```bash
-scai index switch
-```
-
-Switch active repository (by key or indexDir). Run without input for an interactive list of repositories.
-
-
---- 
-
-> **Note:** Indexing very large repositories (millions of lines) may take **hours or days**. Please be patient, and only index huge codebases if you are ok with some extra processing taking place on your computer.
-
-The `scai index` command **automatically** starts a background daemon that continuously:
-
-* Scans your target directory
-* Summarizes new or changed files
-* Updates embeddings and the search index
-
-You won't gain much value from the index unless you scope it to one repository. 
-
----
-
-### 🔍 Codebase Search & Ask (ALPHA)
-
-> **Important:** You must `index` a **code repository** first or `find` and `ask` have no context to work with.
-
-1. **Set index directory:**
-
-    ```bash
-    scai index set /path/to/repo
-    ```
-
-2. **Index your repo (once):**
-
-   ```bash
-   scai index start
-   ```
-
-3. The daemon is designed to **consume minimal resources** and run unobtrusively. You can control it with:
-
-    ```bash
-    scai daemon        # Start or show daemon status
-    scai stop-daemon   # Stop the background indexer
-    ```
-
-
-4. **Keyword search:**
-
-   ```bash
-   scai find YourClassName
-   ```
-
-5. **Natural-language questions:**
-
-### 🧠 Natural-language questions
-
-Ask questions about your codebase using `scai ask`.
-
-You can run it in two ways:
-
-1. **Inline question**
-
-   ```bash
-   scai ask "How does the controller work?"
-   ```
-
-2. **Interactive prompt**
-
-   ```bash
-   scai ask
-   ```
-
-   **Press enter**
-   , then type your question when prompted:
-
-   ```
-   > How does the controller work?
-   ```
-
-   </br>
-
-### 🚨 **OBS** 🚨
-
-`find` and `ask` rely on that index—without it they will return no useful results.
-
----
-
- Note the **Migrate** command is for **internal use only**. Do **not** run it unless explicitly instructed, as it may delete existing data or corrupt your local database.
-
-If you're upgrading from an earlier version, please run the following commands to avoid indexing issues:
-
-```bash
-scai reset-db
-scai index
-```
-</br>
-
----
-
-## 🛍️ Maintenance & Utilities
-
-* **Reset database (w/ backup):**
-
-  ```bash
-  scai reset-db
-  ```
-* **Backup only of `~/.scai`:**
-
-  ```bash
-  scai backup
-  ```
-
----
-
-## 🧺 Module Pipeline Mode
-
-For custom pipelines on a single file:
-
-```bash
-scai src/file.ts -m summary,comments
-```
----
-
-## 🔐 License & Fair Use
-
-**scai is free to use** for individuals, teams, and commercial projects.
-
-You may:
-
-* ✅ Use internally or commercially
-* ✅ Fork and improve
-* ✅ Recommend to others
-
-You may **not**:
-
-* ❌ Resell as a product or service
-* ❌ Claim ownership of the tool
-
-</br>
-
-### 📄 License
-
-Free for personal and internal company use only.
-Commercial use (resale, SaaS, inclusion in paid tools) is prohibited.
-Contact me for commercial licensing.
-
----
-
-</br>
-
-## 🙌 Feedback
-
-Questions, ideas, or bugs?  
-Ping [@ticcr](https://bsky.app/profile/ticcr.xyz) on Bluesky — I'd love to hear your thoughts!
-
----