01 · Getting Started

First memory
in 5 minutes.

Complete install from zero — Node.js, npm package, licence activation, and your first store + recall. No prior experience required.

Total time
~5 minutes
Difficulty
Beginner
Requires
Windows / macOS / Linux
Version
v1.3.6
1
Prerequisite
Install Node.js 18+

Vektor Slipstream requires Node.js version 18 or higher. If you already have Node.js, skip ahead — just verify your version first.

terminal
node --version
# Must show v18.0.0 or higher
# e.g. v20.20.1 ✓

If you see command not found or a version below 18, install Node.js:

Windows
macOS
Linux
option A — installer
# 1. Go to https://nodejs.org
# 2. Download the LTS version (green button)
# 3. Run the installer — accept all defaults
# 4. Restart PowerShell
# 5. Verify:
node --version
option B — winget
winget install OpenJS.NodeJS.LTS
homebrew
brew install node@20
node --version
or — installer
# Download from https://nodejs.org → LTS
# Run the .pkg installer
node --version
ubuntu / debian
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs
node --version

✓ Done when: node --version shows v18.x.x or higher.

2
Licence
Get your licence key

Purchase Vektor Slipstream at vektormemory.com/product. Your Polar licence key is emailed immediately after checkout.

The key looks like this:

0509B6D1-7D21-43E7-9840-F74A10207531
  • Check your purchase confirmation email from Polar
  • Copy the key exactly — 32 hex characters in UUID format
  • Keep it safe — you'll use it on each new machine

Can't find your key? Log in at polar.sh → Orders → your purchase to retrieve it. Contact [email protected] if you need help.

3
Install
Install the package

Open a terminal (PowerShell on Windows, Terminal on macOS/Linux) and run:

terminal
npm install vektor-slipstream

This downloads the package including the bundled ONNX embedding model (~23MB). First install takes 30–60 seconds.

Windows PowerShell: if you see garbled characters in the output, run this first:
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8

Verify the install:

terminal
npx vektor help

You should see the VEKTOR ASCII banner and the list of CLI commands. If you see an error, check the troubleshooting guide.

✓ Done when: npx vektor help shows the command list without errors.

4
Licence Activation
Activate your licence

Set your licence key as an environment variable, then run the activation command:

Windows
macOS / Linux
powershell
# Set your key (replace with your actual key)
$env:VEKTOR_LICENCE_KEY="0509B6D1-7D21-43E7-9840-F74A10207531"

# Activate
npx vektor activate

To make it permanent across sessions, add it to your system environment variables:
Start → Search "environment variables" → Edit system environment variables → New
Name: VEKTOR_LICENCE_KEY · Value: your key

bash
# Set your key
export VEKTOR_LICENCE_KEY="0509B6D1-7D21-43E7-9840-F74A10207531"

# Activate
npx vektor activate

# Make it permanent — add to ~/.zshrc or ~/.bashrc:
echo 'export VEKTOR_LICENCE_KEY="your-key-here"' >> ~/.zshrc

Expected output:

output
  ✓ Licence activated successfully.
  Run: npx vektor status

Each licence activates on up to 3 machines. If you hit the limit, run npx vektor deactivate on an old machine first, or manage activations at polar.sh.

✓ Done when: you see "Licence activated successfully." Your key is now cached locally — you won't be prompted again on this machine.

5
Verify
Run the smoke test

Confirm everything is working end-to-end:

terminal
npx vektor test

Expected output:

output
  [##############################] 100% Done
  ✓ Memory engine booted
  ✓ Stored memory (id: 1)
  ✓ Recalled 1 result(s) — top score: 0.9741
  ✓ Briefing generated
  ✓ Test database cleaned up

  ✓ All tests passed. VEKTOR is working correctly.

If you see a better-sqlite3 error: run npm rebuild better-sqlite3 in the same directory, then try again. This happens when Node.js was updated after the package was installed.

✓ Done when: "All tests passed." appears. The memory engine is fully operational.

6
Your First Memory
Store and recall

Create a file called test-memory.js and paste this:

test-memory.js
const { createMemory } = require('vektor-slipstream');

async function main() {
  const memory = await createMemory({
    agentId:    'my-agent',
    licenceKey: process.env.VEKTOR_LICENCE_KEY,
    dbPath:     './my-memory.db',
  });

  // Store a memory
  const { id } = await memory.remember(
    'User prefers TypeScript over JavaScript',
    { importance: 4 }
  );
  console.log('✓ Stored — id:', id);

  // Recall by meaning (not keyword)
  const results = await memory.recall('coding language preferences', 5);
  console.log('✓ Recalled:', results[0].content);
  console.log('  Score:', results[0].score.toFixed(4));

  // Traverse the graph
  const graph = await memory.graph('TypeScript', { hops: 2 });
  console.log('✓ Graph nodes:', graph.nodes.length);

  // See what changed
  const delta = await memory.delta('TypeScript', 7);
  console.log('✓ Delta entries:', delta.length);
}

main().catch(console.error);
terminal
node test-memory.js

Expected output:

output
  ╔══════════════════════════════════════════════════════╗
  ║            VEKTOR SLIPSTREAM — ACTIVE                ║
  ╚══════════════════════════════════════════════════════╝
  ⚙️  EP:        CPU·Hash
  🧠  Model:     all-MiniLM-L6-v2 INT8
  ⚡  Embed:     <1ms
  💾  DB:        WAL | mmap:1GB | cache:64MB

✓ Stored — id: 1
✓ Recalled: User prefers TypeScript over JavaScript
  Score: 0.9741
✓ Graph nodes: 1
✓ Delta entries: 1
✓ Memory is working.

A my-memory.db file was created in your project directory. This SQLite file is your persistent memory graph — it survives restarts, model updates, and new sessions. It's yours forever.

7
Optional — Claude Desktop
Connect to Claude Desktop

If you use Claude Desktop, install the VEKTOR extension to give Claude persistent memory across every conversation.

  • Download vektor-slipstream.dxt from your purchase email or the product page
  • Open Claude Desktop → Settings → Extensions
  • Drag the .dxt file onto the Extensions page
  • Enter your licence key when prompted
  • Start a new conversation — four memory tools are now available

Full step-by-step with screenshots: Claude Desktop Extension guide →

✓ Setup complete.

You have a working memory layer. Your agent can now remember across sessions, traverse an associative graph, and generate structured briefings. The .db file is yours — portable, local, permanent.

Next Steps

Reference
API Reference
Full docs for every method — remember(), recall(), graph(), delta(), briefing(), dream().
Claude Desktop
DXT Extension
One drag-and-drop to connect Claude Desktop to your memory. No JSON config required.
Integrations
LangChain · OpenAI
Drop memory into LangChain agents, OpenAI Agents SDK, Mistral, Gemini, and Ollama.
CLI
CLI Reference
TUI browser, REM cycle, briefings, and status checks — all from npx vektor.
Cloak
Stealth Browser
Bot-resistant page fetching, AES-256 vault, and behaviour injection.
Support
Troubleshooting
Common errors with exact fixes — sqlite3 rebuild, licence issues, ONNX not found.
← All Docs API Reference →