Skip to main content
Start with the universal installer. An interactive run detects supported clients and asks before configuring each one. --yes, --non-interactive, or an explicit --targets list skips those prompts.

Agent Instructions

Paste this prompt into your agent to install and verify Memory Crystal. Automatic recall injection remains opt-in even on Full hosts.

Install

macOS, Linux, WSL, or Git Bash:
Native Windows PowerShell:
/crystal redirects to /install.sh.

Choose a target

Bash accepts claude-code, claude-desktop, codex-cli, codex-desktop, opencode, factory-droid, hermes, openclaw, cursor, grok, and generic-mcp.
PowerShell accepts the same ids except hermes. -Targets codex-desktop writes the shared Codex MCP config. It does not install the Bash-only shared hooks, so capture and injection from that PowerShell run are not the same as a Bash install.
Hermes is Bash-only. PowerShell skips shared hooks on every target whose platform row lists shells: ["bash"]. OpenClaw’s native plugin path is also Bash; a PowerShell OpenClaw run writes generic MCP guidance.
Official platforms are Claude Code, Codex, Grok Build, OpenClaw, Hermes Agent, and Buzz. Claude Desktop, Codex Desktop, OpenCode, Factory Droid, Cursor, and generic MCP clients stay installable. See Support Tiers and Installation.

Install one client

Choose one command for the client you want to configure. Hermes and the native OpenClaw plugin need Bash. PowerShell configures MCP and skills where supported; it skips Bash-only hooks. Factory Droid is a Tools-tier installer target.
The PowerShell target provides generic MCP guidance. Use Bash for the native plugin.

What you get

Tools-tier hosts (Claude Desktop, OpenCode, Factory Droid, generic MCP) get tools only. You call capture and recall yourself.

Choose a backend

Cloud and local modes need a Memory Crystal API key. If you pass --api-key or set MEMORY_CRYSTAL_API_KEY, the installer validates that key and does not start a browser device flow. An interactive run with no key opens browser sign-in, then falls back to a pasted key. --yes and --non-interactive fail closed unless a key is already set.
  1. Open memorycrystal.ai/dashboard.
  2. Create or open your account.
  3. Open API Keys and create a key.
The dashboard shows the key once. Local mode stores a separate local credential and does not log the hosted bearer token.
See Local-First Setup for Docker, local dashboard URLs, and backups.

Verify

OpenClaw:
Inside an OpenClaw session, ask the agent to call the crystal_status tool to check plugin status. It is not a shell command. Other clients: reload the app and confirm the memory-crystal tools are listed. From a repository checkout:
npm run convex:local:doctor is a checkout command. From an extracted local-backend artifact, run bin/doctor (or bin/doctor.ps1, which invokes Bash).
If local-first setup fails, confirm Docker is running, then run the artifact doctor before you reinstall.

Client guides