scai 0.1.164 → 0.1.165

package/README.md

@@ -1,98 +1,196 @@
 # ⚙️ SCAI — Source Code AI 🌿
 
-> **AI-powered CLI for local code analysis, commit message suggestions, and natural-language queries.**
-> **100% local • No token cost • Private by design • GDPR-friendly** — made in Denmark/EU with ❤️.
+> **A local-first AI CLI for understanding, querying, and iterating on large codebases.**
+> **100% local • No token costs • No cloud • No prompt injection • Private by design**
 
 🔗 **Website:** [https://scai.dk](https://scai.dk)
+🇪🇺 Built in Denmark / EU
 
-SCAI is your AI coding companion in the terminal. Stay focused on coding while SCAI helps you understand, analyze, and reason about your codebase using local language models.
+---
+
+## What is SCAI?
+
+**SCAI** is an AI-powered command-line tool that helps developers explore and reason about source code using **local large language models only**.
+
+Inspired by tools such as *Claude Code* and *Gemini CLI*, SCAI is designed to feel like a natural extension of the terminal. It enables natural-language interaction with your codebase while deliberately avoiding cloud dependencies and network-connected agents.
+
+SCAI runs entirely on your local system:
+
+* **No token costs** — no usage-based pricing
+* **No internet access for agents**
+* **No prompt injection from web content**
+* No external AI APIs
+* No telemetry or tracking
+* No API keys
+
+Your code never leaves your machine. All analysis and reasoning happens locally.
+
+> **Local model tradeoff**
+> SCAI uses local LLMs. Output quality depends on your hardware and selected model. Cloud-hosted systems may perform better on general reasoning tasks, but SCAI prioritizes privacy, predictability, and control.
+
+---
+
+## ⚠️ Alpha Status
+
+SCAI is currently in **alpha**.
+
+If you have previously installed SCAI, reset the local database before upgrading:
+
+```bash
+scai db reset
+scai index start
+```
+
+Breaking changes and evolving behavior should be expected.
+
+---
+
+## Why SCAI?
+
+### 🔐 Local-Only by Design
+
+SCAI agents operate **entirely offline**.
+
+They do not:
+
+* Browse the web
+* Fetch URLs
+* Ingest external documents
+* Execute remote prompts
 
-**Local Model Note:** SCAI runs entirely on local LLMs. This means **no API keys, no token cost, and full privacy**, but also **more limited capabilities** compared to cloud-hosted AI.
+**Security implications:**
 
-> ⚠️ **Alpha Version Notice**
-> If you have previously installed SCAI, please run:
->
-> bash
-> scai db reset && scai index start
-> 
->
-> before using this version.
+* No prompt injection via web content
+* No data exfiltration
+* No hidden network calls
+* Fully auditable execution
+
+This makes SCAI suitable for **private repositories, regulated environments, and GDPR-compliant workflows**.
 
 ---
 
-## 🧠 Why SCAI?
+### 🧠 Codebase-Aware Analysis
+
+SCAI builds and maintains a structured internal representation of your repository using:
+
+* Language-aware parsing
+* Symbol and dependency indexing
+* Static and heuristic analysis
+* Cross-file context tracking
+
+This enables repository-level questions that go beyond single-file inspection.
 
-SCAI is not just another AI tool — it's a **developer-first**, **privacy-focused**, and **local-first** coding companion. Here's why SCAI stands out:
+---
 
-### 🔐 **100% Local & Private by Design**
+### ✂️ Assisted Code Iteration (Early)
 
-Unlike cloud-based AI tools, SCAI runs entirely on your machine. No data leaves your environment — making it ideal for **sensitive codebases** and **GDPR-compliant workflows**.
+SCAI can assist with **lightweight, example-driven code iteration**, primarily focused on understanding and improving existing code rather than large-scale automated refactoring.
 
-### 🧠 **Deep Code Understanding**
+Current strengths include:
 
-SCAI doesn't just parse code — it **understands** it. With background indexing, static analysis, and language-aware parsing, SCAI helps you explore, refactor, and debug with confidence.
+* Explaining what functions, files, or modules do
+* Identifying patterns and responsibilities across files
+* Generating or improving comments and documentation
+* Highlighting structural or readability issues
+* Suggesting small, localized improvements
 
-### 📦 **No Token Costs or API Keys**
+Changes are **guided by indexed context and user prompts**, and are intended to support human review and decision-making.
 
-SCAI works offline, with **zero token usage**. You don’t pay for API calls or subscribe to cloud services. Just install and go.
+Large-scale or fully automated repository-wide refactoring should currently be considered **experimental**.
 
-### 🛠️ **Developer-Focused Toolset**
+---
 
-From commit message generation to architecture summaries, SCAI integrates directly into your workflow. It's built for developers, by developers.
+### 🛠 Built for Developer Workflows
 
-### 🇩🇰 **Built in Denmark/EU**
+SCAI is a **terminal-native tool** designed to integrate cleanly into daily development:
 
-SCAI is developed in the European Union, ensuring compliance with data protection laws and a focus on privacy-first development.
+* Natural-language queries over your codebase
+* Code understanding and exploration
+* Assisted iteration and suggestions
+* Commit message generation
+* Background indexing and analysis
+* Interactive REPL
 
-> ✅ SCAI is your **AI coding assistant that respects your privacy**, enhances your productivity, and works **entirely offline**.
+No browser UI. No cloud login. No vendor lock-in.
 
 ---
 
-## 🗣️ Language Support (Important)
+### 🇪🇺 Privacy & Compliance First
 
-SCAI is currently **tested and validated only on the following languages**:
+* Fully local execution
+* No telemetry
+* No cloud services
+* Developed in Denmark / EU
+* GDPR-friendly by default
+
+---
 
-* **JavaScript (JS)**
-* **TypeScript (TS)**
+## Language Support
+
+SCAI is currently **tested and supported** for:
+
+* **JavaScript**
+* **TypeScript**
 * **Java**
 
-Other languages may work partially, but analysis quality, indexing accuracy, and agent behavior are **not guaranteed** outside these languages. Broader language support is planned, but for now SCAI should be considered **JS/TS/Java-first**.
+Other languages may work partially, but indexing quality, analysis accuracy, and agent behavior are **not guaranteed**.
+
+SCAI should currently be considered **JS / TS / Java-first**.
 
 ---
 
-## 💻 Getting Started
+## Getting Started
 
-### 1️⃣ Install & Initialize
+### Install & Initialize
 
-bash
+```bash
 npm install -g scai
 scai init
 scai index start
+```
 
+This:
 
-This initializes local models (recommended: `qwen3-coder:30b`) and starts indexing your code repository.
+* Initializes local configuration
+* Starts the background daemon
+* Begins indexing the current repository
 
-> ⏳ **Note:** Initial indexing and analysis can take **minutes to hours** depending on repository size and enabled analysis tools.
+> **Note**
+> Initial indexing can take **minutes to hours**, depending on repository size and enabled analysis.
 
-### 2️⃣ Check Available Commands
+---
+
+### Starting SCAI
+
+Running the `scai` command with no arguments starts the interactive shell:
 
 ```bash
-scai --help
+scai
 ```
 
----
+You can also start it explicitly:
+
+```bash
+scai shell
+```
 
-## 🏠 REPL Mode (Local AI Queries)
+---
 
-Start an interactive REPL to ask natural-language questions about your code:
+### View Available Commands
 
 ```bash
-scai shell
+scai --help
 ```
 
-Once in the REPL, you can:
+---
+
+## Interactive REPL
+
+The REPL is the primary interface for working with SCAI.
+
+### Ask questions about your codebase
 
-### Ask questions about your codebase. Be specific for better results. 
+Be specific for better results.
 
 ```text
 scai> what does withContext function do in index.ts file?
@@ -103,32 +201,28 @@ scai> Where are all the database queries defined?
 scai> List files involved in authentication
 ```
 
-### Run CLI commands from inside the REPL
+### Run CLI commands inside the REPL
 
 ```text
-scai> /git commit
-scai> /index list
-scai> /index set /path/to/repo
-scai> /index switch
-scai> /index delete
+/index list
+/index switch
+/git commit
 ```
 
 ### Execute shell commands
 
 ```text
-scai> !ls -la
-scai> !git status
+!git status
+!ls -la
 ```
 
-> ✅ REPL queries are free, offline, GDPR-friendly, and **no token cost**.
+All interactions remain **offline and free**, with **no token usage**.
 
 ---
 
-## 📦 Repository Indexing
+## Repository Indexing
 
-Before SCAI can answer questions, your repository must be indexed.
-
-### Common Index Commands
+Repositories must be indexed before querying:
 
 ```bash
 scai index set /path/to/repo
@@ -138,47 +232,43 @@ scai index switch
 scai index delete
 ```
 
-Only indexed repositories can be queried.
+Only indexed repositories are accessible to agents.
 
 ---
 
-## 🧠 Background Indexing & Analysis (Daemon)
-
-SCAI performs **deep repository indexing and static analysis** using background workers. This includes:
+## Background Analysis (Daemon)
 
-* File structure discovery
-* Language-aware parsing (JS / TS / Java)
-* Symbol and dependency mapping
-* Heuristic analysis for tests, architecture, and patterns
+SCAI performs deep analysis in the background, including:
 
-⚠️ **Important:** On first install or on large repositories, this process can take **several hours**.
+* File discovery
+* AST parsing
+* Dependency graph construction
+* Symbol resolution
+* Heuristic structure analysis
 
-All background work is handled by the **SCAI daemon**, which can be fully controlled from the CLI.
-
-### Daemon Commands
+Daemon control:
 
 ```bash
 scai daemon start
 scai daemon stop
 scai daemon restart
 scai daemon status
-scai daemon unlock
 scai daemon logs
 ```
 
-You can safely stop the daemon at any time. Indexing and analysis will resume when restarted.
+Indexing progress resumes automatically after restart.
 
 ---
 
-## ⚙️ Configuration
+## Configuration
 
-Set the local AI model (recommended):
+Set a local model (recommended):
 
 ```bash
 scai config set-model qwen3-coder:30b
 ```
 
-View current configuration:
+View configuration:
 
 ```bash
 scai config show --raw
@@ -186,22 +276,22 @@ scai config show --raw
 
 ---
 
-## 🔧 Git Commit Assistant
+## Git Commit Assistant
 
-Generate meaningful commit messages based on staged changes:
+Generate commit messages from staged changes:
 
 ```bash
 git add .
 scai git commit
 ```
 
-All analysis is performed locally — **no token usage, no cloud calls**.
+All diff inspection and reasoning is performed locally.
 
 ---
 
-## 🔑 GitHub Authentication
+## GitHub Authentication
 
-For GitHub-related features, SCAI requires a Personal Access Token.
+Required only for GitHub-related features:
 
 ```bash
 scai auth set
@@ -211,98 +301,78 @@ scai auth reset
 
 ---
 
-## 🧠 Example Queries
-
-* `Summarize codeTransform.js`
-* `Explain utils/helpers.ts architecture`
-* `List all functions without tests in services/`
-* `Show where database queries are defined`
-* `Highlight potential memory leaks`
-* `Describe how authentication works`
-* `Summarize repo architecture`
-
----
-
-## 🔐 Privacy & GDPR
+## Privacy & Security Summary
 
-* Fully local — no cloud calls
+* 100% local execution
+* No internet access for agents
+* No prompt injection from web content
 * No API keys
-* **No token cost**
-* GDPR-friendly, built in Denmark/EU 🇩🇰
+* No token costs
+* GDPR-friendly by default
 
 ---
 
-## 🙌 Feedback & Support
-
-Feedback, bugs, and ideas are very welcome:
+## Feedback & Community
 
-* 🌍 Website: [https://scai.dk](https://scai.dk)
-* 🧵 Threads: [@scai.dk](https://threads.net/@scai.dk)
-
-<br>
+* 🌍 [https://scai.dk](https://scai.dk)
+* 🧵 [https://threads.net/@scai.dk](https://threads.net/@scai.dk)
 
 ---
 
-<br>
-<br>
-
-## 🔐 License & Usage Terms
+# License & Usage Terms
 
-Copyright © SCAI
-All rights reserved.
+© SCAI — All rights reserved.
 
-SCAI is **free to use for non-commercial purposes only**, subject to the terms below.
+SCAI is **free for non-commercial use only**.
 
 ---
 
-## ✅ Permitted Use
+## Permitted Use
 
-You may use SCAI **without charge** for the following purposes:
+You may use SCAI free of charge for:
 
 * Personal projects
 * Educational use
 * Research and experimentation
-* Non-commercial open-source contributions
-* Internal evaluation or proof-of-concept work
+* Non-commercial open-source work
+* Internal evaluation or proof-of-concepts
 
-You may also **fork, modify, and redistribute** the source code, provided that such use remains **strictly non-commercial**.
+You may fork and modify the source code **for non-commercial purposes only**.
 
 ---
 
-## 🚫 Restricted Use
+## Restricted Use
 
-The following uses are **not permitted without a commercial license**:
+The following require a **commercial license**:
 
-* Commercial use of any kind
-* Enterprise or organizational deployment
-* Use as part of a paid product, service, or subscription
-* Use in consultancy, client work, or billable services
-* Bundling or integrating SCAI into commercial software or internal enterprise tooling
-* Resale, sublicensing, or redistribution for commercial purposes
+* Any commercial or enterprise use
+* Consultancy or client work
+* Paid products or services
+* Internal enterprise tooling
+* Commercial redistribution or resale
 
 ---
 
-## 🏢 Commercial & Enterprise Licensing
+## Commercial Licensing
 
-**Commercial and enterprise use requires a paid license and explicit permission from the author.**
+Commercial and enterprise use requires a **paid license** and explicit permission from the author.
 
-Organizations or individuals wishing to use SCAI in a commercial context must obtain a commercial license **prior to such use**.
-
-Please contact the author to discuss commercial licensing terms.
+Please contact the author to discuss licensing terms.
 
 ---
 
-## ⚖️ Disclaimer
+## Disclaimer
 
-This software is provided **"as is"**, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.
+This software is provided **“as is”**, without warranty of any kind.
 
-In no event shall the author be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
+The author is not liable for any damages arising from its use.
 
 ---
 
-### 📄 Summary (Non-Binding)
+### Non-Binding Summary
 
 * Free for personal and non-commercial use
-* Commercial and enterprise use requires a paid license
-* Commercial redistribution is prohibited
-
+* Fully local, offline AI
+* No token costs
+* No prompt injection surface
+* Commercial use requires a license

package/package.json

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