> ## Documentation Index
> Fetch the complete documentation index at: https://docs.memorycrystal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get Memory Crystal working quickly, then choose hosted or local-first storage for your AI client.

Start with the universal installer. It detects supported clients, asks before configuring each one, and lets you choose cloud or local backend mode.

## Agent Instructions

Copy and paste this directly into your agent, and it will know what to do:

```text theme={"system"}
Install Memory Crystal for the agent I am using. Run the official Memory Crystal installer for this client and operating system, follow the auth/backend prompts, do not manually edit config files unless the installer fails, then verify that Memory Crystal tools are available. Refer to this page for the exact command to run for this platform and agent: https://docs.memorycrystal.ai/installation
```

Common target commands:

```bash theme={"system"}
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets openclaw
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets hermes
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets claude-code
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets codex-cli
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets factory-droid
```

```powershell theme={"system"}
iwr https://memorycrystal.ai/install.ps1 -OutFile install.ps1
.\install.ps1 -Targets claude-code
.\install.ps1 -Targets claude-desktop
.\install.ps1 -Targets codex-cli
.\install.ps1 -Targets factory-droid
```

<Warning>Hermes Agent is not supported by the native PowerShell installer yet. OpenClaw PowerShell writes generic MCP guidance; use Bash, WSL, or Git Bash for the native OpenClaw plugin install. On macOS/Linux/WSL the installer auto-configures Codex Desktop via the shared `~/.codex/config.toml` (`--targets codex-desktop` or `codex-cli`); on native Windows PowerShell, Codex Desktop still requires generic MCP/manual setup.</Warning>

## Universal install

For macOS, Linux, WSL, or Git Bash:

```bash theme={"system"}
curl -fsSL https://memorycrystal.ai/crystal | bash
```

For native Windows PowerShell, use the PowerShell companion when available for your release:

```powershell theme={"system"}
iwr https://memorycrystal.ai/install.ps1 -UseBasicParsing | iex
```

The installer can configure:

* OpenClaw
* Hermes Agent
* Claude Code
* Claude Desktop
* Codex CLI
* Factory Droid
* generic MCP clients

It prompts before changing each detected client and creates backups before config edits.

## Choose a deployment mode

| Mode                     | Best for                                    | Details                                                                               |
| ------------------------ | ------------------------------------------- | ------------------------------------------------------------------------------------- |
| **Cloud** (recommended)  | Easiest setup, shared memory across devices | Uses Memory Crystal's hosted backend                                                  |
| **Local-first**          | Single-machine data control                 | Uses Docker Convex on `127.0.0.1` for data while hosted auth/license remains required |
| **External self-hosted** | Advanced operators                          | Uses your own Convex deployment when supported by the installer                       |

See [Local-First Setup](/configuration/local-first) for Docker requirements, local dashboard URLs, backup behavior, and rollback notes.

## Single-client installer paths

Use these when you intentionally want one client path instead of the universal prompt flow.

<AccordionGroup>
  <Accordion title="Claude Code">
    ```bash theme={"system"}
    curl -fsSL https://memorycrystal.ai/install-claude-mcp.sh | bash
    ```

    See [Claude Code](/integrations/claude-code).
  </Accordion>

  <Accordion title="Codex CLI">
    ```bash theme={"system"}
    curl -fsSL https://memorycrystal.ai/install-codex-mcp.sh | bash
    ```

    See [Codex CLI](/integrations/codex-cli).
  </Accordion>

  <Accordion title="Hermes Agent">
    ```bash theme={"system"}
    curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets hermes
    ```

    See [Hermes Agent](/integrations/hermes-agent).
  </Accordion>

  <Accordion title="Factory Droid">
    ```bash theme={"system"}
    curl -fsSL https://memorycrystal.ai/install-droid-mcp.sh | bash
    ```

    See [Factory Droid](/integrations/factory-droid).
  </Accordion>

  <Accordion title="Claude Desktop">
    Use the config shown on the [Claude Desktop](/integrations/claude-desktop) page when your installer release does not yet mutate Claude Desktop config automatically.
  </Accordion>
</AccordionGroup>

## Pick your platform

Cloud and external self-hosted modes need a Memory Crystal API key. Local-first mode still needs hosted account/device auth so Memory Crystal can validate license entitlement before provisioning local credentials.

1. Visit [memorycrystal.ai/dashboard](https://memorycrystal.ai/dashboard)
2. Create or open your account
3. Go to **API Keys**
4. Create a key and save it somewhere safe

<Warning>The dashboard only shows the key once. Local mode stores local client credentials separately and should never log hosted bearer/device tokens.</Warning>

## Verify your setup

For OpenClaw installs:

```bash theme={"system"}
openclaw plugins info crystal-memory
openclaw crystal_status
```

For source checkouts:

```bash theme={"system"}
npm run crystal:doctor
```

For local Docker Convex, also verify the local backend health from the installed artifact or from a repo checkout:

```bash theme={"system"}
npm run convex:local:doctor
```

<Tip>
  If local-first setup fails, run the local backend doctor from the installed artifact and verify Docker is running before reinstalling.
</Tip>