scai 0.1.30 → 0.1.31

package/README.md

@@ -1,146 +1,223 @@
-# ⚙️ scai — Smart Commit AI ✨
+# ⚙️ scai — Semantic CLI Assistant ✨
 
-> AI-powered CLI tool for smart commit messages, code comments, summaries, test generation, and changelogs — all powered by local models.
+> AI-powered CLI tool for commits, summaries, search, questions, and more — using local models.
 
-**scai** (Smart Commit AI) is a lightweight, privacy-focused CLI tool that helps developers work faster and cleaner:
+**scai** is a privacy-first, local AI assistant for developers. It brings semantic understanding to your codebase, directly from the terminal:
 
-- 💬 Suggest high-quality Git commit messages  
-- ✨ Automatically comment your code  
-- 🧠 Summarize code files instantly in the terminal  
-- 🧪 Generate test files for your code (JavaScript/TypeScript)  
-- 📝 Generate changelog entries based on Git diffs  
-- 🔒 100% local — no API keys, no cloud, no telemetry
+- 💬 Suggest intelligent Git commit messages  
+- ✨ Comment and refactor code files  
+- 🧐 Summarize files in plain English  
+- 📜 Auto-update your changelog  
+- 🧪 Generate Jest tests (ALPHA)  
+- 🔍 Search and ask questions across your codebase (BETA)  
+- 🔐 100% local — no API keys, no cloud, no telemetry
 
 ---
 
 ## 🚀 Features
 
-- ⚡️ Powered by local AI models (e.g., `llama3`, `codellama`)  
+- ⚡ Powered by open-source models (e.g. `llama3`, `codellama`)  
+- 🔍 Full-text indexing & semantic search (BETA)  
 - 🛠️ Built with Node.js and TypeScript  
-- 🔒 No external services or APIs required  
-- ✅ Global options to select model and programming language
+- ✅ Easily configurable via CLI or global flags  
 
 ---
 
 ## ❤️ Why Local AI?
 
-At scai, we believe your code — and your workflow — should stay **yours**. That's why we prioritize **local models** and **privacy-first** development:
+**Your code stays yours.**  
+scai runs entirely on your machine and doesn't require cloud APIs or API keys. That means:
 
-- ✅ **Local models**: scai runs entirely on your machine, with no need for cloud-based processing. We use open-source models like `llama3` and `codellama`, ensuring that your code stays private and secure.
-- ✅ **Privacy by design**: We do not send your code to the cloud, store your data, or require API keys. Your data remains 100% local, ensuring full control over your project.
-- ✅ **EU & Danish friendly**: As a Danish company, we are deeply committed to respecting European privacy regulations (GDPR). This means no data collection, no tracking, and full compliance with the strictest data protection laws.
-  
-By running everything locally, you can be sure that your sensitive code and workflows stay safe, private, and within your control.
+- ✅ **Privacy-first**: no telemetry, no server round-trips  
+- ✅ **EU & GDPR-friendly**: designed with compliance in mind  
+- ✅ **Developer control**: full transparency and override options  
 
 ---
 
 ## 📦 Installation
 
-1. **Install Ollama:**  
-   - On **Windows**: [Download Ollama](https://ollama.com/download)  
-   - On **macOS**: via Homebrew (`brew install ollama`) or [download from Ollama](https://ollama.com)
+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
+   ```bash
+   npm install -g scai
     ```
 
-3. **Initialize the tool and models:**  
-    ```bash
-    scai init
-    ```
+3. **Initialize models:**
 
-This will download required models and set up scai.
+   ```bash
+   scai init
+   ```
 
----
 
-## ⚒️ Usage Examples
+## ⚒️ Usage Overview
 
-### 🔧 Git Commands
+### 🔧 Git Commit Suggestions
 
-- **Suggest a commit message:**  
-    ```bash
-    git add .  
-    scai git sugg  
-    ```
+```bash
+git add .
+scai git sugg
+```
 
-    *Example output:*  
-    ```
-    feat(api): add error handling to user service
-    ```
+Suggests a meaningful commit message based on your staged code.
+To auto-commit:
 
-    To commit automatically with the suggestion:  
-    ```bash
-    scai git sugg --commit
-    ```
+```bash
+scai git sugg --commit
+```
 
-### 🛠️ Generate Code-Related Output (`gen` commands)
+---
 
-- **Summarize a code file:**  
-    ```bash
-    scai gen summ <file>
-    ```
+### 🛠️ Code Generation Commands (`gen` group)
 
-    Prints a summary of what the code does directly in the terminal. You can also pipe file content:  
-    ```bash
-    cat <file> | scai gen summ
-    ```
+```bash
+scai gen summ <file>
+scai gen comm <file>
+scai gen changelog
+scai gen tests <file>
+```
 
-- **Generate tests for a code file:**  
-    ```bash
-    scai gen tests <file>
-    ```
+* `summ`: Summarize a file
+* `comm`: Add comments or refactor suggestions
+* `changelog`: Update or create `CHANGELOG.md` from Git diff
+* `tests`: Create Jest test stubs (ALPHA)
 
-    Creates a Jest test file for the specified JavaScript/TypeScript module.
+You can also pipe file content directly:
 
-- **Update the changelog:**  
-    ```bash
-    scai gen changelog
-    ```
+```bash
+cat src/utils/math.ts | scai gen summ
+```
 
-    Analyzes the current Git diff and updates (or creates) a `CHANGELOG.md` file with relevant changes.
+---
 
 ## ⚙️ Configuration
 
-scai stores your configuration locally in the `~/.scai/config.json` file. You can configure the model and programming language settings as follows:
+scai stores settings in `~/.scai/config.json`. You can override or view them:
 
-- **Set the model:**  
-    ```bash
-    scai set model <model>
-    ```
+* **Set model:**
 
-    e.g., `scai set model codellama:7b`
+  ```bash
+  scai set model codellama:7b
+  ```
+* **Set language:**
 
-- **Set the programming language:**  
-    ```bash
-    scai set lang <lang>
-    ```
+  ```bash
+  scai set lang ts
+  ```
+* **Show config:**
+
+  ```bash
+  scai config
+  ```
+
+<br>
+
+## 🔁 Background Daemon and Indexing ⚠️ Beta Notice
+
+These features are experimental and subject to change:
+
+* `index`, `find`, `ask`
+* `daemon`, `stop-daemon`
+* `gen tests` (test generation)
+
+<br>
+
+> **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.
 
-    e.g., `scai set lang rust`
+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 (BETA)
+
+> **Important:** You must `index` a **code repository** first or `find` and `ask` have no context to work with.
+
+1. **Set index directory:**
 
-- **Show current configuration:**  
     ```bash
-    scai config
+    scai set index-dir /path/to/repo
     ```
 
-You can also use global options `--model` and `--lang` with any command to override the settings:  
+2. **Index your repo (once):**
+
+   ```bash
+   scai index 
+   ```
+
+3. The daemon is designed to **consume minimal resources** and run unobtrusively. You can control it with:
+
     ```bash
-    scai --model codellama:34b --lang ts git sugg
+    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:**
+
+   ```bash
+   scai ask "How does mapcontrol work?"
+   ```
+
+`find` and `ask` rely on that index—without it they will return no useful results.
+
+
+---
+
+## 🛍️ Maintenance & Utilities
+
+* **Reset database (w/ backup):**
+
+  ```bash
+  scai reset-db
+  ```
+* **Manual backup 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 companies — including in commercial work.
+**scai is free to use** for individuals, teams, and commercial projects.
 
 You may:
-- ✅ Use it internally in your projects  
-- ✅ Use it at work or in commercial development  
-- ✅ Share and recommend it  
 
-But you may not:
-- ❌ Repackage or resell **scai** as a product or SaaS  
-- ❌ Claim ownership of the tool
+* ✅ Use internally or commercially
+* ✅ Fork and improve
+* ✅ Recommend to others
+
+You may **not**:
+
+* ❌ Resell as a product or service
+* ❌ Claim ownership of the tool
 
 See [LICENSE](./LICENSE) for full terms.
+
+```

package/package.json

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