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

# Quickstart

> Install the xysq CLI and wire persistent memory into every AI agent on your machine with one command.

The xysq CLI is a cross-agent installer. With one command, it detects every AI agent on your machine — Claude Code, Cursor, Codex, Claude Desktop, Gemini CLI, Copilot CLI, Antigravity — and wires the xysq MCP server and memory skill into each one's config. No per-agent setup, no copy-pasting JSON snippets.

## Install

```bash theme={"dark"}
npm install -g @xysq-ai/cli
```

Or run without installing:

```bash theme={"dark"}
npx @xysq-ai/cli install
```

**Requires Node 18+.**

## Get an API key

Sign in at [app.xysq.ai/connect](https://app.xysq.ai/connect) and click **Generate API Key**. It starts with `xysq_`.

## Install for every detected agent

```bash theme={"dark"}
xysq install
```

The CLI will:

1. Prompt for your API key (or read it from `XYSQ_API_KEY` env / `--api-key` flag).
2. Validate the key against `api.xysq.ai/whoami`.
3. Store the key securely in your OS keychain (macOS Keychain / Windows Credential Manager / Linux libsecret).
4. Detect every supported agent installed on your machine.
5. Wire the xysq MCP server into each agent's config (preserving every other server you've configured).
6. Install the xysq memory skill where the host supports one.

```
✓ Validated as you@example.com
✓ claude-code        wired       installed
✓ cursor             wired       installed
✓ codex              wired       installed
✓ antigravity        wired       –

Done. Restart your agents to pick up xysq.
```

Restart your agents and they'll have persistent memory across every session.

## Install for specific agents only

Pass agent names to skip auto-detection:

```bash theme={"dark"}
xysq install codex cursor
```

Or use `--only` / `--skip`:

```bash theme={"dark"}
xysq install --only claude-code,codex
xysq install --skip claude-desktop
```

Valid agent names: `claude-code`, `claude-desktop`, `cursor`, `codex`, `gemini-cli`, `copilot-cli`, `antigravity`.

## Non-interactive (CI / dotfiles)

```bash theme={"dark"}
xysq install --api-key xysq_... --yes --json
```

Or via env:

```bash theme={"dark"}
export XYSQ_API_KEY=xysq_...
xysq install --yes
```

`--json` emits a machine-readable report; `--yes` skips all confirmation prompts.

## Next steps

* [Commands reference](/cli/commands) — full flag list for every command
* [Supported agents](/cli/agents) — what gets written where, per host
* [Configuration](/cli/configuration) — env vars, state, cache, logs
* [Troubleshooting](/cli/troubleshooting) — common errors and exit codes