Get Started with Wyrm

The 10-minute path from npm install to "my AI just remembered what we did last Tuesday."

Prerequisites

• Node.js 22+ (Wyrm uses native ESM and the Node 22 fetch global)
• An MCP-capable AI client — Claude Code, Claude Desktop, Cursor, Windsurf, Continue, Zed, or any other client that speaks the Model Context Protocol
• Nothing else. Semantic search is on by default: wyrm-setup downloads a small local embedding model (nomic-embed-text-v1.5-int8, 138 MB, Apache-2.0). No account, no API key, no Ollama. Already running Ollama for this? Existing setups keep working unchanged.

Path

1. Install — npm install -g wyrm-mcp. Termux/PRoot users: the preinstall hook auto-patches node-gyp's -flto=4 so better-sqlite3 builds cleanly.

2. Connect your AI — run wyrm-setup. It detects every installed MCP client, writes the config for each, and downloads the local embedding model. wyrm-setup list shows what it supports; wyrm-setup export mcp-json prints a portable config block for any client it does not yet know.

3. Restart your client, then ask it to call wyrm_capabilities. That is the handshake — if it answers, you are connected.

4. Just work. There is no indexing step: Wyrm enrols a git repository the first time it sees one. Your agent calls wyrm_session_prime at the start of a session and captures as it goes.

Check the result at any time with wyrm doctor, which names the resolved provider and the exact fix for anything degraded, or wyrm-ui for the dashboard.

What's already in your install

wyrm-mcp     The stdio MCP server (point your AI client here)
wyrm         CLI for direct DB queries outside an AI client
             (`wyrm serve` starts the HTTP API + dashboard on :3333)
wyrm-setup   Auto-detect installed AI clients and write MCP config
wyrm-loop    Long-lived OODA scheduler daemon (autonomous goals)
wyrm-ui      Open the local Wyrm Web UI in your default browser
wyrm-guard   Deterministic PreToolUse hook — blocks known-failure inputs

After installing, run wyrm-setup to auto-configure every detected AI client at once, then wyrm-ui to see the dashboard.

When things go wrong

See TROUBLESHOOTING.md for the three real-world failure modes covered with per-distro fixes.