Skip to main content
Installation connects Memory Crystal to your AI client and chooses where Memory Crystal data should live.

​
Primary installer

For Bash environments: 
curl -fsSL https://memorycrystal.ai/crystal | bash
For native Windows PowerShell, use the PowerShell companion when available for your release: 
iwr https://memorycrystal.ai/install.ps1 -UseBasicParsing | iex
The universal installer is the preferred path because it can detect supported clients, ask before changing each target, choose cloud or local-first backend mode, and print rollback guidance.

​
Backend choices

BackendWhat it usesNotes
CloudHosted Memory Crystal backendRecommended for most users
Local-firstDocker Convex on 127.0.0.1Data plane is local; hosted auth/license is still required
External self-hostedOperator-provided Convex URLAdvanced path when supported by your release
Read Local-First Setup before choosing local mode. It documents Docker requirements, local dashboard URLs, config backups, local credential behavior, and rollback.

​
Supported clients

ClientRecommended path
OpenClawUniversal installer, then accept the OpenClaw prompt
Claude CodeUniversal installer, or Claude Code single-client installer
Claude DesktopUniversal installer when supported, otherwise Claude Desktop manual config
Codex CLIUniversal installer, or Codex CLI single-client installer
Factory DroidUniversal installer, or Factory Droid single-client installer
Generic MCPUniversal installer generic MCP prompt, or MCP Server

​
Single-client installer paths

These paths remain available for compatibility and focused installs: 
curl -fsSL https://memorycrystal.ai/install-claude-mcp.sh | bash
curl -fsSL https://memorycrystal.ai/install-codex-mcp.sh | bash
curl -fsSL https://memorycrystal.ai/install-droid-mcp.sh | bash
OpenClaw uses the primary /crystal installer.

​
Safety guarantees installers should preserve

  • ask before configuring each detected client
  • create a backup before every config mutation
  • validate JSON/TOML where applicable before and after writes
  • restore the previous config when validation fails
  • redact API keys, bearer tokens, device codes, and local credentials from logs
  • avoid package-manager or service changes without a prompt

​
Self-hosting

For infrastructure-oriented self-hosting, see:

​
Docs preview

Mintlify docs for this repo live under apps/docs. 
cd apps/docs
npx mint dev

​
Backend choices

BackendEndpoint shapeNotes
Cloud hostedhttps://api.memorycrystal.ai/mcpDefault and easiest setup
Local Docker Convexhttp://127.0.0.1:3211/api/mcpLocal data plane with hosted auth/license bridge
External self-hostedyour Convex site URLAdvanced operators; verify your deployment and auth policy
  • run through Quickstart
  • verify tool access with crystal_wake, crystal_remember, and crystal_recall
  • keep the printed config backup path until you have verified the client works

​
Source of truth

  • apps/web/public/install.sh
  • apps/web/public/install.ps1
  • apps/web/public/install-claude-mcp.sh
  • apps/web/public/install-codex-mcp.sh
  • apps/web/public/install-droid-mcp.sh
  • scripts/convex-local-*.sh
  • scripts/convex-local-*.ts
  • .env.example