SuperLocalMemory

https://superlocalmemory.com/docs
Admin
SuperLocalMemory is a local-first adaptive memory system for developers that integrates with 17+ AI...
Tokens:1,886
Snippets:52
Trust Score:3.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Run SuperLocalMemory Setup Wizard

Source: https://superlocalmemory.com/docs/install

Initiates the setup wizard for SuperLocalMemory after installation. Allows selection between Mode A (zero-cloud), Mode B (local Ollama), or Mode C (cloud LLM). Mode A is the default.

```bash
slm setup
```

--------------------------------

### Install LlamaIndex Integration

Source: https://superlocalmemory.com/docs

Install the local-first chat store package for LlamaIndex compatibility.

```bash
pip install llama-index-storage-chat-store-superlocalmemory
```

--------------------------------

### Install SuperLocalMemory via pip

Source: https://superlocalmemory.com/docs/install

Installs SuperLocalMemory as a standard Python package. Requires Python 3.11+. After installation, run `slm setup` and `slm warmup`.

```bash
pip install superlocalmemory
```

--------------------------------

### Install LangChain Integration

Source: https://superlocalmemory.com/docs

Install the SuperLocalMemory backend for LangChain to enable persistent chat history.

```bash
pip install langchain-superlocalmemory
```

--------------------------------

### Install CLI via NPM

Source: https://superlocalmemory.com/docs

Install the SuperLocalMemory CLI globally using the Node Package Manager.

```bash
npm install -g superlocalmemory
```

--------------------------------

### Verify SuperLocalMemory Installation

Source: https://superlocalmemory.com/docs/install

Checks the current status of the SuperLocalMemory installation and its components. Useful for confirming that the installation was successful and all services are running correctly.

```bash
slm status
```

--------------------------------

### Clone SuperLocalMemory Repository

Source: https://superlocalmemory.com/docs/install

Clones the SuperLocalMemory source code from GitHub. This method is intended for development or use in air-gapped environments. After cloning, navigate into the directory and install using pip.

```bash
git clone https://github.com/qualixar/superlocalmemory.git
```

```bash
cd superlocalmemory
```

```bash
pip install -e .
```

--------------------------------

### Upgrade SuperLocalMemory from V2

Source: https://superlocalmemory.com/docs/install

Commands to upgrade SuperLocalMemory from V2 to V3. This involves reinstalling the package, migrating V2 data, and reconfiguring the setup. A backup of V2 data is created automatically.

```bash
npm install -g superlocalmemory
```

```bash
slm migrate
```

```bash
slm setup
```

```bash
slm warmup
```

--------------------------------

### Auto-Configure IDEs with SuperLocalMemory

Source: https://superlocalmemory.com/docs/install

Automatically configures all detected Integrated Development Environments (IDEs) to work with SuperLocalMemory's MCP server. Use `--list` to see which IDEs are configured.

```bash
slm connect
```

```bash
slm connect --list
```

--------------------------------

### Troubleshoot 'slm: command not found'

Source: https://superlocalmemory.com/docs/install

Provides a solution for the 'slm: command not found' error. This typically occurs when the npm global bin or Python scripts directory is not in the system's PATH.

```bash
npm bin -g
```

--------------------------------

### Manual MCP Configuration for IDEs

Source: https://superlocalmemory.com/docs/install

Provides the JSON configuration snippet to manually add SuperLocalMemory to an IDE's MCP configuration file. This allows tools that support MCP to connect to the SuperLocalMemory command-line interface.

```json
{
  "mcpServers": {
    "superlocalmemory": {
      "command": "slm",
      "args": ["mcp"]
    }
  }
}
```

--------------------------------

### Pre-download SuperLocalMemory Embedding Model

Source: https://superlocalmemory.com/docs/install

Optionally pre-downloads the nomic-embed-text-v1.5 model (~500MB). If skipped, the model downloads automatically on first use. This command is useful for ensuring the model is available before the first query.

```bash
slm warmup
```

--------------------------------

### Rollback SuperLocalMemory Migration

Source: https://superlocalmemory.com/docs/install

Command to roll back the V3 migration to V2. This is useful if issues arise after upgrading and you need to revert to the previous version's data.

```bash
slm migrate --rollback
```
Tokens:
Raw