superlocalmemory 3.4.16 → 3.4.18

package/docs/configuration.md

@@ -1,182 +0,0 @@
-# Configuration
-> SuperLocalMemory V3 Documentation
-> https://superlocalmemory.com | Part of Qualixar
-
-Control how SuperLocalMemory stores, retrieves, and processes your memories.
-
----
-
-## Three Operating Modes
-
-SuperLocalMemory runs in one of three modes. You pick the trade-off between privacy and power.
-
-| Mode | What it does | Needs API key? | Data leaves your machine? |
-|------|-------------|:--------------:|:-------------------------:|
-| **A: Zero-Cloud** | Math-based retrieval. No LLM calls. | No | Never |
-| **B: Local LLM** | Mode A + a local LLM via Ollama. | No | Never |
-| **C: Cloud LLM** | Mode B + a cloud LLM for maximum recall quality. | Yes | Yes (queries only) |
-
-### Check your current mode
-
-```bash
-slm mode
-```
-
-### Switch modes
-
-```bash
-slm mode a    # Zero-cloud (default)
-slm mode b    # Local LLM
-slm mode c    # Cloud LLM
-```
-
-Switching modes takes effect immediately. No data is lost.
-
-### Mode A: Zero-Cloud (Default)
-
-All operations run locally. Retrieval uses four channels (semantic similarity, keyword search, entity graph, and temporal context) combined with mathematical scoring. No network calls.
-
-Best for: privacy-sensitive work, air-gapped environments, EU AI Act compliance.
-
-### Mode B: Local LLM
-
-Everything from Mode A, plus a local LLM (via Ollama) that improves recall by understanding query intent and reranking results.
-
-**Setup:**
-
-```bash
-# Install Ollama (if not already installed)
-brew install ollama          # macOS
-curl -fsSL https://ollama.com/install.sh | sh  # Linux
-
-# Pull a model
-ollama pull llama3.2
-
-# Switch to Mode B
-slm mode b
-```
-
-Best for: developers who want better recall without sending data to the cloud.
-
-### Mode C: Cloud LLM
-
-Everything from Mode B, plus a cloud LLM for cross-encoder reranking and agentic multi-round retrieval. Highest recall quality.
-
-**Setup:**
-
-```bash
-slm mode c
-slm provider set openai
-```
-
-You will be prompted for your API key (stored locally in your config file, never transmitted except to the provider you choose).
-
-Best for: maximum recall quality when privacy constraints allow cloud calls.
-
-## Provider Configuration
-
-Mode C supports multiple LLM providers.
-
-### Set your provider
-
-```bash
-slm provider           # Show current provider
-slm provider set       # Interactive provider selector
-```
-
-### Supported providers
-
-| Provider | Command | Env variable |
-|----------|---------|-------------|
-| OpenAI | `slm provider set openai` | `OPENAI_API_KEY` |
-| Anthropic | `slm provider set anthropic` | `ANTHROPIC_API_KEY` |
-| Azure OpenAI | `slm provider set azure` | `AZURE_OPENAI_API_KEY` |
-| Ollama (local) | `slm provider set ollama` | None needed |
-| OpenRouter | `slm provider set openrouter` | `OPENROUTER_API_KEY` |
-
-### Set API keys
-
-You can set keys interactively or via environment variables:
-
-```bash
-# Interactive (stored in config file)
-slm provider set openai
-# Prompts: Enter your OpenAI API key: sk-...
-
-# Via environment variable (takes precedence)
-export OPENAI_API_KEY="sk-..."
-```
-
-## Config File
-
-All settings live in:
-
-```
-~/.superlocalmemory/config.json
-```
-
-### Example config
-
-```json
-{
-  "mode": "a",
-  "profile": "default",
-  "provider": {
-    "name": "openai",
-    "model": "gpt-4o-mini",
-    "api_key_env": "OPENAI_API_KEY"
-  },
-  "auto_capture": true,
-  "auto_recall": true,
-  "embedding_model": "all-MiniLM-L6-v2",
-  "max_recall_results": 10,
-  "retention": {
-    "default_policy": "indefinite"
-  }
-}
-```
-
-### Key settings
-
-| Setting | Default | Description |
-|---------|---------|-------------|
-| `mode` | `"a"` | Operating mode: `a`, `b`, or `c` |
-| `profile` | `"default"` | Active memory profile |
-| `auto_capture` | `true` | Automatically store decisions and context |
-| `auto_recall` | `true` | Automatically inject relevant memories |
-| `embedding_model` | `"all-MiniLM-L6-v2"` | Sentence transformer for semantic search |
-| `max_recall_results` | `10` | Maximum memories returned per query |
-
-## Environment Variables
-
-These override config file settings when set:
-
-| Variable | Purpose |
-|----------|---------|
-| `SLM_MODE` | Override operating mode |
-| `SLM_PROFILE` | Override active profile |
-| `SLM_DATA_DIR` | Override data directory (default: `~/.superlocalmemory/`) |
-| `OPENAI_API_KEY` | OpenAI API key for Mode C |
-| `ANTHROPIC_API_KEY` | Anthropic API key for Mode C |
-| `AZURE_OPENAI_API_KEY` | Azure OpenAI API key for Mode C |
-| `OPENROUTER_API_KEY` | OpenRouter API key for Mode C |
-
-## Database Location
-
-All data is stored locally in:
-
-```
-~/.superlocalmemory/memory.db    # SQLite database
-~/.superlocalmemory/config.json  # Configuration
-~/.superlocalmemory/backups/     # Automatic backups
-```
-
-To use a custom location:
-
-```bash
-export SLM_DATA_DIR="/path/to/your/data"
-```
-
----
-
-*SuperLocalMemory V3 — Copyright 2026 Varun Pratap Bhardwaj. Elastic License 2.0. Part of Qualixar.*

package/docs/getting-started.md

@@ -1,102 +0,0 @@
-# Getting Started
-> SuperLocalMemory V3 Documentation
-> https://superlocalmemory.com | Part of Qualixar
-
-Get your AI's memory system running in under 5 minutes. **V3.1: Now with Active Memory — your memory learns from your usage and gets smarter over time, at zero token cost.**
-
----
-
-## Prerequisites
-
-- **Node.js** 18 or later
-- **Python** 3.10 or later (installed automatically on most systems)
-- An AI coding tool (Claude Code, Cursor, VS Code, Windsurf, or any MCP-compatible IDE)
-
-## Install
-
-```bash
-npm install -g superlocalmemory
-```
-
-This installs the `slm` command globally.
-
-## Run the Setup Wizard
-
-```bash
-slm setup
-```
-
-The wizard walks you through three choices:
-
-1. **Pick your mode**
-   - **Mode A** (default) — Zero cloud. All memory stays on your machine. No API key needed.
-   - **Mode B** — Local LLM. Uses Ollama on your machine for smarter recall.
-   - **Mode C** — Cloud LLM. Uses OpenAI, Anthropic, or another provider for maximum power.
-
-2. **Connect your IDE** — The wizard detects installed IDEs and configures them automatically.
-
-3. **Verify installation** — A quick self-test confirms everything works.
-
-> **Tip:** Start with Mode A. You can switch to B or C anytime with `slm mode b` or `slm mode c`.
-
-## Store Your First Memory
-
-```bash
-slm remember "The project uses PostgreSQL 16 on port 5433, not the default 5432"
-```
-
-You should see:
-
-```
-Stored memory #1 (Mode A, profile: default)
-```
-
-## Recall a Memory
-
-```bash
-slm recall "what database port do we use"
-```
-
-Output:
-
-```
-[1] The project uses PostgreSQL 16 on port 5433, not the default 5432
-    Score: 0.94 | Stored: 2 minutes ago | Profile: default
-```
-
-## Check System Status
-
-```bash
-slm status
-```
-
-This shows:
-
-- Current mode (A, B, or C)
-- Active profile
-- Total memories stored
-- Database location
-- Health of math layers (Fisher, Sheaf, Langevin)
-
-## How It Works With Your IDE
-
-Once connected, SuperLocalMemory works automatically:
-
-- **Auto-recall** — When your AI assistant responds, relevant memories are injected as context. No manual queries needed.
-- **Auto-capture** — Decisions, bug fixes, architecture choices, and preferences are stored as you work. No manual tagging needed.
-
-You can still use `slm remember` and `slm recall` from the terminal whenever you want explicit control.
-
-## Next Steps
-
-| What you want to do | Guide |
-|---------------------|-------|
-| Set up a specific IDE | [IDE Setup](ide-setup.md) |
-| Switch modes or providers | [Configuration](configuration.md) |
-| Learn all CLI commands | [CLI Reference](cli-reference.md) |
-| Migrate from V2 | [Migration from V2](migration-from-v2.md) |
-| Understand how it works | [Architecture](architecture.md) |
-
----
-
-*SuperLocalMemory V3 — Copyright 2026 Varun Pratap Bhardwaj. Elastic License 2.0. Part of Qualixar.*

package/docs/ide-setup.md

@@ -1,261 +0,0 @@
-# IDE Setup
-> SuperLocalMemory V3 Documentation
-> https://superlocalmemory.com | Part of Qualixar
-
-Connect SuperLocalMemory to your AI coding tool. Once connected, memories are captured and recalled automatically.
-
----
-
-## Auto-Detection
-
-The fastest way to connect all your IDEs:
-
-```bash
-slm connect
-```
-
-This scans your system for installed IDEs, configures each one, and verifies the connection. Run it once after installing SLM.
-
-To connect a specific IDE:
-
-```bash
-slm connect claude
-slm connect cursor
-slm connect vscode
-```
-
-## Claude Code
-
-**Auto:**
-
-```bash
-slm connect claude
-```
-
-**Manual:** Add to `~/.claude.json`:
-
-```json
-{
-  "mcpServers": {
-    "superlocalmemory": {
-      "command": "npx",
-      "args": ["-y", "superlocalmemory", "mcp"],
-      "env": {}
-    }
-  }
-}
-```
-
-Restart Claude Code. Verify with: `slm status` in a Claude Code session.
-
-## Cursor
-
-**Auto:**
-
-```bash
-slm connect cursor
-```
-
-**Manual:** Add to `~/.cursor/mcp.json`:
-
-```json
-{
-  "mcpServers": {
-    "superlocalmemory": {
-      "command": "npx",
-      "args": ["-y", "superlocalmemory", "mcp"],
-      "env": {}
-    }
-  }
-}
-```
-
-Restart Cursor. The memory tools appear in the tool list automatically.
-
-## VS Code / GitHub Copilot
-
-**Auto:**
-
-```bash
-slm connect vscode
-```
-
-**Manual:** Add to VS Code settings (JSON):
-
-```json
-{
-  "mcp": {
-    "servers": {
-      "superlocalmemory": {
-        "command": "npx",
-        "args": ["-y", "superlocalmemory", "mcp"]
-      }
-    }
-  }
-}
-```
-
-## Windsurf
-
-**Auto:**
-
-```bash
-slm connect windsurf
-```
-
-**Manual:** Add to `~/.windsurf/mcp.json`:
-
-```json
-{
-  "mcpServers": {
-    "superlocalmemory": {
-      "command": "npx",
-      "args": ["-y", "superlocalmemory", "mcp"],
-      "env": {}
-    }
-  }
-}
-```
-
-## Gemini CLI
-
-**Auto:**
-
-```bash
-slm connect gemini
-```
-
-**Manual:** Add to `~/.gemini/settings.json`:
-
-```json
-{
-  "mcpServers": {
-    "superlocalmemory": {
-      "command": "npx",
-      "args": ["-y", "superlocalmemory", "mcp"]
-    }
-  }
-}
-```
-
-## JetBrains (IntelliJ, PyCharm, WebStorm, etc.)
-
-**Auto:**
-
-```bash
-slm connect jetbrains
-```
-
-**Manual:** Open **Settings > Tools > AI Assistant > MCP Servers** and add:
-
-| Field | Value |
-|-------|-------|
-| Name | `superlocalmemory` |
-| Command | `npx` |
-| Arguments | `-y superlocalmemory mcp` |
-
-Restart the IDE after adding the server.
-
-## Continue.dev
-
-**Auto:**
-
-```bash
-slm connect continue
-```
-
-**Manual:** Add to `~/.continue/config.json`:
-
-```json
-{
-  "mcpServers": [
-    {
-      "name": "superlocalmemory",
-      "command": "npx",
-      "args": ["-y", "superlocalmemory", "mcp"]
-    }
-  ]
-}
-```
-
-## Zed
-
-**Auto:**
-
-```bash
-slm connect zed
-```
-
-**Manual:** Add to `~/.config/zed/settings.json`:
-
-```json
-{
-  "context_servers": {
-    "superlocalmemory": {
-      "command": {
-        "path": "npx",
-        "args": ["-y", "superlocalmemory", "mcp"]
-      }
-    }
-  }
-}
-```
-
-## Verifying the Connection
-
-After connecting any IDE, verify it works:
-
-1. Open a chat/prompt session in your IDE
-2. Ask: "What do you know about my preferences?"
-3. If SLM is connected, the AI will check your memories before responding
-
-Or run from the terminal:
-
-```bash
-slm status
-```
-
-Look for `Connected IDEs: claude, cursor, ...` in the output.
-
-## Troubleshooting
-
-### "slm command not found"
-
-The npm global bin directory is not in your PATH.
-
-```bash
-# Find where npm installs global packages
-npm root -g
-
-# Add the bin directory to your PATH
-# For zsh (~/.zshrc):
-export PATH="$(npm root -g)/../bin:$PATH"
-
-# For bash (~/.bashrc):
-export PATH="$(npm root -g)/../bin:$PATH"
-```
-
-### IDE does not detect SLM tools
-
-1. Ensure SLM is installed globally: `npm list -g superlocalmemory`
-2. Restart the IDE completely (not just reload)
-3. Check the MCP config file has correct JSON syntax
-4. Run `slm connect <ide>` to regenerate the config
-
-### "Connection refused" or timeout errors
-
-```bash
-# Test the MCP server directly
-npx superlocalmemory mcp --test
-
-# Check for port conflicts
-slm status --verbose
-```
-
-### Multiple IDE configs conflicting
-
-Each IDE has its own config file. They do not conflict. All IDEs share the same memory database at `~/.superlocalmemory/memory.db`.
-
----
-
-*SuperLocalMemory V3 — Copyright 2026 Varun Pratap Bhardwaj. Elastic License 2.0. Part of Qualixar.*