scai 0.1.83 → 0.1.85

package/README.md

@@ -0,0 +1,452 @@
+# ⚙️ 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
+📦 Resolving GitHub repo info from indexDir: ./
+🔗 Git origin URL: git@github.com:org/repo.git
+✅ Parsed: owner='org', repo='repo'
+👤 Authenticated user: dev-user123
+
+🔍 Fetching pull requests and diffs...
+✅ Fetched 5 PR(s) with diffs.
+
+📦 Open Pull Requests with review requested:
+| # | ID   | TITLE                         | AUTHOR     | STATUS | CREATED    | REVIEWERS                     | REVIEWS             |
+| - | ---- | ----------------------------- | ---------- | ------ | ---------- | ----------------------------- | ------------------- |
+| 1 | #120 | fix/session-timeout         | dev-alice  | Open   | 2025-08-08 | code-analyzer\[bot], dev-bob  | ✅ Approved          |
+| 2 | #118 | feature/1482-support-wfs2   | dev-carol  | Open   | 2025-08-07 | code-analyzer\[bot], dev-dave | ✅ Approved          |
+| 3 | #117 | refactor/win-server-support | dev-erin   | Open   | 2025-08-06 | dev-frank, dev-alice          | ❌ Changes Requested |
+| 4 | #114 | bump/vue-i18n-9.14.5        | dependabot | Open   | 2025-08-04 | code-analyzer\[bot]           | ✅ Approved          |
+| 5 | #113 | bugfix/null-navigator-check | dev-bob    | Open   | 2025-08-03 | dev-alice, dev-carol          | ✅ Approved          |
+
+👉 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!
+
+---

package/dist/commands/RefactorCmd.js

@@ -2,15 +2,13 @@ import fs from 'fs/promises';
 import path from 'path';
 import { runModulePipeline } from '../pipeline/runModulePipeline.js';
 import { addCommentsModule } from '../pipeline/modules/commentModule.js';
+import { normalizePath } from '../utils/normalizePath.js';
 export async function handleRefactor(filepath, options = {}) {
     try {
-        // Normalize path: add ./ prefix if no directory specified
-        if (!filepath.startsWith('./') && !filepath.startsWith('/') && !filepath.includes('\\')) {
-            filepath = `./${filepath}`;
-        }
+        // Normalize and resolve filepath (includes expanding ~ and consistent slashes)
+        filepath = normalizePath(filepath);
         const { dir, name, ext } = path.parse(filepath);
         const refactoredPath = path.join(dir, `${name}.refactored${ext}`);
-        // --apply flag: use existing refactored file and overwrite original
         if (options.apply) {
             try {
                 const refactoredCode = await fs.readFile(refactoredPath, 'utf-8');
@@ -23,13 +21,10 @@ export async function handleRefactor(filepath, options = {}) {
             }
             return;
         }
-        // Read source code
         const content = await fs.readFile(filepath, 'utf-8');
-        // Run through pipeline modules
         const response = await runModulePipeline([addCommentsModule], { content });
         if (!response.content.trim())
             throw new Error('⚠️ Model returned empty result');
-        // Save refactored output
         await fs.writeFile(refactoredPath, response.content, 'utf-8');
         console.log(`✅ Refactored code saved to: ${refactoredPath}`);
         console.log(`ℹ️ Run again with '--apply' to overwrite the original.`);

package/dist/commands/ReviewCmd.js

@@ -164,24 +164,6 @@ function askReviewApproval() {
         });
     });
 }
-function askFinalReviewApproval() {
-    return new Promise((resolve) => {
-        console.log('\n---');
-        console.log('1) ✅ Approve');
-        console.log('2) ❌ Request Changes');
-        console.log('3) 🚫 Cancel');
-        const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
-        rl.question(`\n👉 Choose an option [1-3]: `, (answer) => {
-            rl.close();
-            if (answer === '1')
-                resolve('approve');
-            else if (answer === '2')
-                resolve('request-changes');
-            else
-                resolve('cancel');
-        });
-    });
-}
 // Prompt for custom review
 function promptCustomReview() {
     return new Promise((resolve) => {
@@ -212,23 +194,20 @@ function chunkDiff(diff, review_id) {
         const fullChunk = 'diff --git ' + chunk;
         const filePathMatch = fullChunk.match(/^diff --git a\/(.+?) b\//);
         const filePath = filePathMatch ? filePathMatch[1] : 'unknown';
-        // Now we extract hunks and lines as per the DiffHunk type
         const hunks = [];
         let currentHunk = null;
-        // Split chunk into lines
+        // This counts diff lines for *this file only* (context/+/- lines after first @@)
+        let positionCounter = 0;
         const lines = fullChunk.split('\n');
         lines.forEach(line => {
-            const hunkHeaderMatch = line.match(/^@@ -(\d+),(\d+) \+(\d+),(\d+) @@/);
+            const hunkHeaderMatch = line.match(/^@@ -(\d+),?(\d*) \+(\d+),?(\d*) @@/);
             if (hunkHeaderMatch) {
-                // When we encounter a new hunk, process the previous one (if it exists) and start a new one
-                if (currentHunk) {
+                if (currentHunk)
                     hunks.push(currentHunk);
-                }
-                // Parse the hunk header
                 const oldStart = parseInt(hunkHeaderMatch[1], 10);
                 const newStart = parseInt(hunkHeaderMatch[3], 10);
-                const oldLines = parseInt(hunkHeaderMatch[2], 10);
-                const newLines = parseInt(hunkHeaderMatch[4], 10);
+                const oldLines = parseInt(hunkHeaderMatch[2] || '0', 10);
+                const newLines = parseInt(hunkHeaderMatch[4] || '0', 10);
                 currentHunk = {
                     oldStart,
                     newStart,
@@ -236,33 +215,33 @@ function chunkDiff(diff, review_id) {
                     newLines,
                     lines: [],
                 };
+                return; // don’t count @@ header line in positionCounter
             }
-            else if (currentHunk) {
-                // Process the lines inside the hunk
+            if (currentHunk) {
+                // Each line after @@ counts towards the diff position
+                positionCounter++;
                 let lineType = 'context';
                 if (line.startsWith('+'))
                     lineType = 'add';
                 if (line.startsWith('-'))
                     lineType = 'del';
-                // Create the DiffLine object
                 currentHunk.lines.push({
                     line,
                     type: lineType,
                     lineNumberOld: lineType === 'del' ? currentHunk.oldStart++ : undefined,
                     lineNumberNew: lineType === 'add' ? currentHunk.newStart++ : undefined,
-                    review_id, // Assign the review_id here
+                    position: positionCounter, // <-- key for GitHub inline API
+                    review_id,
                 });
             }
         });
-        // Push the last hunk (if any)
-        if (currentHunk) {
+        if (currentHunk)
             hunks.push(currentHunk);
-        }
         return {
             filePath,
             content: fullChunk,
-            hunks, // Return hunks, which now contain DiffLine objects with line numbers and review_id
-            review_id, // Assign the review_id here for each chunk
+            hunks,
+            review_id,
         };
     });
 }
@@ -419,48 +398,36 @@ export async function reviewPullRequestCmd(branch = 'main', showAll = false) {
             for (let i = 0; i < chunks.length; i++) {
                 const chunk = chunks[i];
                 const { choice, summary } = await reviewChunk(chunk, i, chunks.length);
-                if (choice === 'approve') {
-                    reviewComments.push({
-                        path: chunk.filePath,
-                        body: summary,
-                        line: chunk.hunks[0]?.newStart || 1,
-                        side: 'RIGHT',
-                    });
-                    console.log(`💬 Posted AI review for chunk ${i + 1}`);
-                }
-                else if (choice === 'reject') {
-                    allApproved = false;
-                    reviewComments.push({
-                        path: chunk.filePath,
-                        body: summary,
-                        line: chunk.hunks[0]?.newStart || 1,
-                        side: 'RIGHT',
-                    });
+                if (choice === 'cancel' || choice === 'skip') {
+                    console.log(chalk.gray(`⏭️ Skipped chunk ${i + 1}`));
+                    continue;
                 }
-                else if (choice === 'custom') {
-                    const customReview = await promptCustomReview();
-                    reviewComments.push({
-                        path: chunk.filePath,
-                        body: customReview,
-                        line: chunk.hunks[0]?.newStart || 1,
-                        side: 'RIGHT',
-                    });
+                // Find the first line in the chunk with a valid position (usually the first 'add' or 'context' line)
+                const firstLineWithPosition = chunk.hunks
+                    .flatMap(hunk => hunk.lines)
+                    .find(line => line.position !== undefined);
+                if (!firstLineWithPosition) {
+                    console.warn(`⚠️ Could not find valid position for inline comment in chunk ${i + 1}. Skipping comment.`);
+                    continue;
                 }
-                else if (choice === 'cancel' || choice === 'skip') {
-                    console.log(chalk.gray(`⏭️ Skipped chunk ${i + 1}`));
+                let commentBody = summary;
+                if (choice === 'custom') {
+                    commentBody = await promptCustomReview();
                 }
-                else if (typeof choice === 'string') {
-                    reviewComments.push({
-                        path: chunk.filePath,
-                        body: choice,
-                        line: chunk.hunks[0]?.newStart || 1,
-                        side: 'RIGHT',
-                    });
+                else if (typeof choice === 'string' && !['approve', 'reject', 'custom'].includes(choice)) {
+                    commentBody = choice;
                 }
+                reviewComments.push({
+                    path: chunk.filePath,
+                    body: commentBody,
+                    position: firstLineWithPosition.position,
+                });
+                if (choice === 'reject')
+                    allApproved = false;
             }
             console.log(chalk.blueBright('\n📝 Review Comments Preview:'));
             reviewComments.forEach((comment, idx) => {
-                console.log(`${idx + 1}. ${comment.path}:${comment.line} [${comment.side}] — ${comment.body}`);
+                console.log(`${idx + 1}. ${comment.path}:${comment.position} — ${comment.body}`);
             });
             const shouldApprove = allApproved;
             const hasInlineComments = reviewComments.length > 0;

package/dist/github/github.js

@@ -81,30 +81,29 @@ export async function submitReview(prNumber, body, event, comments) {
     const token = await ensureGitHubAuth();
     const { owner, repo } = await getRepoDetails();
     const url = `https://api.github.com/repos/${owner}/${repo}/pulls/${prNumber}/reviews`;
+    // Prepare payload
+    const payload = { body, event };
+    if (comments && comments.length > 0) {
+        payload.comments = comments;
+    }
     const res = await fetch(url, {
         method: 'POST',
         headers: {
             Authorization: `token ${token}`,
             Accept: 'application/vnd.github.v3+json',
         },
-        body: JSON.stringify({
-            body,
-            event,
-            comments,
-        }),
+        body: JSON.stringify(payload),
     });
     if (!res.ok) {
         const errorText = await res.text();
-        // Attempt to parse error body
         let parsed = {};
         try {
             parsed = JSON.parse(errorText);
         }
         catch (_) {
-            // leave as raw text if parsing fails
+            // fallback to raw text
         }
-        const knownErrors = Array.isArray(parsed.errors) ? parsed.errors.join('; ') : '';
-        // Handle known error cases
+        const knownErrors = Array.isArray(parsed.errors) ? parsed.errors.map((e) => e.message || e).join('; ') : '';
         if (res.status === 422) {
             if (knownErrors.includes('Can not approve your own pull request')) {
                 console.warn(`⚠️ Skipping approval: You cannot approve your own pull request.`);
@@ -114,8 +113,8 @@ export async function submitReview(prNumber, body, event, comments) {
                 console.warn(`⚠️ Cannot post comments: PR has no diff.`);
                 return;
             }
-            if (knownErrors.includes('path is missing') || knownErrors.includes('line is missing')) {
-                console.warn(`⚠️ Some inline comments are missing a path or line number. Skipping review.`);
+            if (knownErrors.includes('path is missing') || knownErrors.includes('line is missing') || knownErrors.includes('position is missing')) {
+                console.warn(`⚠️ Some inline comments are missing required fields. Skipping review.`);
                 return;
             }
             if (knownErrors.includes('Position is invalid') || knownErrors.includes('line must be part of the diff')) {
@@ -123,7 +122,6 @@ export async function submitReview(prNumber, body, event, comments) {
                 return;
             }
         }
-        // Unknown error
         throw new Error(`Failed to submit review: ${res.status} ${res.statusText} - ${errorText}`);
     }
     console.log(`✅ Submitted ${event} review for PR #${prNumber}`);

package/dist/utils/normalizePath.js

@@ -1,4 +1,5 @@
 // src/utils/normalizePath.ts
+import os from 'os';
 import path from "path";
 /**
  * Normalizes a path string for loose, fuzzy matching:
@@ -11,6 +12,9 @@ export function normalizePathForLooseMatch(p) {
 }
 // Helper to normalize and resolve paths to a consistent format (forward slashes)
 export function normalizePath(p) {
+    if (p.startsWith('~')) {
+        p = path.join(os.homedir(), p.slice(1));
+    }
     return path.resolve(p).replace(/\\/g, '/');
 }
 export function getRepoKeyForPath(pathToMatch, config) {

package/package.json

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