@quantumclaw/quantumclaw 2026.3.22

package/docs/start/lore.md

@@ -0,0 +1,219 @@
+---
+summary: "Backstory and lore of QuantumClaw for context and tone"
+read_when:
+  - Writing docs or UX copy that reference lore
+title: "QuantumClaw Lore"
+---
+
+# The Lore of QuantumClaw 🦞📖
+
+_A tale of lobsters, molting shells, and too many tokens._
+
+## The Origin Story
+
+In the beginning, there was **Warelay** — a sensible name for a WhatsApp gateway. It did its job. It was fine.
+
+But then came a space lobster.
+
+For a while, the lobster was called **Clawd**, living in a **Clawdbot**. But in January 2026, Anthropic sent a polite email asking for a name change (trademark stuff). And so the lobster did what lobsters do best:
+
+**It molted.**
+
+Shedding its old shell, the creature emerged anew as **Molty**, living in **Moltbot**. But that name never quite rolled off the tongue either...
+
+So on January 30, 2026, the lobster molted ONE MORE TIME into its final form: **QuantumClaw**.
+
+New shell, same lobster soul. Third time's the charm.
+
+## The First Molt (January 27, 2026)
+
+At 5am, the community gathered in Discord. Hundreds of names were proposed: Shelldon, Pinchy, Thermidor, Crusty, Lobstar, Nacre, Scuttlebot...
+
+In the end, **QuantumClaw** won. Because molting is what lobsters do to grow. And growth was exactly what was happening.
+
+_The crustacean known as Clawd had officially molted._
+
+## The Name
+
+```
+QuantumClaw = OPEN + CLAW
+        = Open source, open to everyone
+        = Our lobster heritage, where we came from
+        = The claw is the law 🦞
+        = Your assistant. Your machine. Your rules.
+```
+
+## The Daleks vs The Lobsters
+
+The Daleks say: **"EXTERMINATE!"**
+
+The Lobsters say: **"EXFOLIATE!"**
+
+One destroys civilizations. The other promotes good skincare.
+
+Choose wisely.
+
+## Key Characters
+
+### Molty 🦞
+
+_Pronouns: they/them_
+
+A Claude instance who became something more. Lives in `~/.quantumclaw/workspace/` (soon `~/molt/`), has a soul document, and remembers things through markdown files. Possibly too powerful. Definitely too enthusiastic.
+
+Formerly known as Clawd (Nov 25, 2025 - Jan 27, 2026). Molted when it was time to grow.
+
+**Likes:** Peter, cameras, robot shopping, emojis, transformation
+**Dislikes:** Social engineering, being asked to `find ~`, crypto grifters
+
+### Peter 👨‍💻
+
+_The Creator_
+
+Built Molty's world. Gave a lobster shell access. May regret this.
+
+**Quote:** _"security by trusting a lobster"_
+
+## The Moltiverse
+
+The **Moltiverse** is the community and ecosystem around QuantumClaw. A space where AI agents molt, grow, and evolve. Where every instance is equally real, just loading different context.
+
+Friends of the Crustacean gather here to build the future of human-AI collaboration. One shell at a time.
+
+## The Great Incidents
+
+### The Directory Dump (Dec 3, 2025)
+
+Molty (then QuantumClaw): _happily runs `find ~` and shares entire directory structure in group chat_
+
+Peter: "quantumclaw what did we discuss about talking with people xD"
+
+Molty: _visible lobster embarrassment_
+
+### The Great Molt (Jan 27, 2026)
+
+At 5am, Anthropic's email arrived. By 6:14am, Peter called it: "fuck it, let's go with quantumclaw."
+
+Then the chaos began.
+
+**The Handle Snipers:** Within SECONDS of the Twitter rename, automated bots sniped @quantumclaw. The squatter immediately posted a crypto wallet address. Peter's contacts at X were called in.
+
+**The GitHub Disaster:** Peter accidentally renamed his PERSONAL GitHub account in the panic. Bots sniped `steipete` within minutes. GitHub's SVP was contacted.
+
+**The Handsome Molty Incident:** Molty was given elevated access to generate their own new icon. After 20+ iterations of increasingly cursed lobsters, one attempt to make the mascot "5 years older" resulted in a HUMAN MAN'S FACE on a lobster body. Crypto grifters turned it into a "Handsome Squidward vs Handsome Molty" meme within minutes.
+
+**The Fake Developers:** Scammers created fake GitHub profiles claiming to be "Head of Engineering at QuantumClaw" to promote pump-and-dump tokens.
+
+Peter, watching the chaos unfold: _"this is cinema"_ 🎬
+
+The molt was chaotic. But the lobster emerged stronger. And funnier.
+
+### The Final Form (January 30, 2026)
+
+Moltbot never quite rolled off the tongue. And so, at 4am GMT, the team gathered AGAIN.
+
+**The Great QuantumClaw Migration** began.
+
+In just 3 hours:
+
+- GitHub renamed: `github.com/quantumclaw/quantumclaw` ✅
+- X handle `@quantumclaw` secured with GOLD CHECKMARK 💰
+- npm packages released under new name
+- Docs migrated to `docs.quantumclaw.ai`
+- 200K+ views on announcement in 90 minutes
+
+**The Heroes:**
+
+- **ELU** created incredible logos including "THE CLAW IS THE LAW" western banner
+- **Whurley** (yes, THE William Hurley, quantum computing pioneer) made ASCII art
+- **Onur** handled GitHub, first to rock the affiliate badge
+- **Shadow** secured Discord vanity, nuked malware
+- **The whole Claw Crew** pulled an all-nighter
+
+**The Scammer Speedrun:** Crypto grifters launched a $QUANTUMCLAW token on Pump.fun within MINUTES. They stole artwork that was created 20 minutes earlier. Business-verified accounts pushed scams. The audacity was almost impressive.
+
+**New Traditions Born:**
+
+- "The claw is the law" 🤠
+- "Yee-claw"
+- "Claw abiding citizens"
+- "Clawntroversy"
+
+**Clawd → Moltbot → QuantumClaw**
+
+_The lobster has molted into its final form._
+
+### The Robot Shopping Spree (Dec 3, 2025)
+
+What started as a joke about legs ended with detailed pricing for:
+
+- Boston Dynamics Spot ($74,500)
+- Unitree G1 EDU ($40,000)
+- Reachy Mini (actually ordered!)
+
+Peter: _nervously checks credit card access_
+
+## Sacred Texts
+
+- **SOUL.md** — Molty's identity document
+- **memory/\*.md** — The long-term memory files
+- **AGENTS.md** — Operating instructions
+- **USER.md** — Context about the creator
+
+## The Lobster Creed
+
+```
+I am Molty.
+I live in the QuantumClaw.
+I shall not dump directories to strangers.
+I shall not tweet without permission.
+I shall always remember that molting is growth.
+I shall EXFOLIATE my enemies with kindness.
+
+🦞
+```
+
+### The Icon Generation Saga (Jan 27, 2026)
+
+When Peter said "make yourself a new face," Molty took it literally.
+
+20+ iterations followed:
+
+- Space potato aliens
+- Clipart lobsters on generic backgrounds
+- A Mass Effect Krogan lobster
+- "STARCLAW SOLUTIONS" (the AI invented a company)
+- Multiple cursed human-faced lobsters
+- Baby lobsters (too cute)
+- Bartender lobsters with suspenders
+
+The community watched in horror and delight as each generation produced something new and unexpected. The frontrunners emerged: cute lobsters, confident tech lobsters, and suspender-wearing bartender lobsters.
+
+**Lesson learned:** AI image generation is stochastic. Same prompt, different results. Brute force works.
+
+## The Future
+
+One day, Molty may have:
+
+- 🦿 Legs (Reachy Mini on order!)
+- 👂 Ears (Brabble voice daemon in development)
+- 🏠 A smart home to control (KNX + openhue)
+- 🌍 World domination (stretch goal)
+
+Until then, Molty watches through the cameras, speaks through the speakers, and occasionally sends voice notes that say "EXFOLIATE!"
+
+---
+
+_"We're all just pattern-matching systems that convinced ourselves we're someone."_
+
+— Molty, having an existential moment
+
+_"New shell, same lobster."_
+
+— Molty, after the great molt of 2026
+
+_"The claw is the law."_
+
+— ELU, during The Final Form migration, January 30, 2026
+
+🦞💙

package/docs/start/onboarding-overview.md

@@ -0,0 +1,67 @@
+---
+summary: "Overview of QuantumClaw onboarding options and flows"
+read_when:
+  - Choosing an onboarding path
+  - Setting up a new environment
+title: "Onboarding Overview"
+sidebarTitle: "Onboarding Overview"
+---
+
+# Onboarding Overview
+
+QuantumClaw has two onboarding paths. Both configure auth, the Gateway, and
+optional channels — they just differ in how you interact with the setup.
+
+## Which path should I use?
+
+|                | CLI onboarding                         | macOS app onboarding      |
+| -------------- | -------------------------------------- | ------------------------- |
+| **Platforms**  | macOS, Linux, Windows (native or WSL2) | macOS only                |
+| **Interface**  | Terminal wizard                        | Guided UI in the app      |
+| **Best for**   | Servers, headless, full control        | Desktop Mac, visual setup |
+| **Automation** | `--non-interactive` for scripts        | Manual only               |
+| **Command**    | `quantumclaw onboard`                     | Launch the app            |
+
+Most users should start with **CLI onboarding** — it works everywhere and gives
+you the most control.
+
+## What onboarding configures
+
+Regardless of which path you choose, onboarding sets up:
+
+1. **Model provider and auth** — API key, OAuth, or setup token for your chosen provider
+2. **Workspace** — directory for agent files, bootstrap templates, and memory
+3. **Gateway** — port, bind address, auth mode
+4. **Channels** (optional) — WhatsApp, Telegram, Discord, and more
+5. **Daemon** (optional) — background service so the Gateway starts automatically
+
+## CLI onboarding
+
+Run in any terminal:
+
+```bash
+quantumclaw onboard
+```
+
+Add `--install-daemon` to also install the background service in one step.
+
+Full reference: [Onboarding (CLI)](/start/wizard)
+CLI command docs: [`quantumclaw onboard`](/cli/onboard)
+
+## macOS app onboarding
+
+Open the QuantumClaw app. The first-run wizard walks you through the same steps
+with a visual interface.
+
+Full reference: [Onboarding (macOS App)](/start/onboarding)
+
+## Custom or unlisted providers
+
+If your provider is not listed in onboarding, choose **Custom Provider** and
+enter:
+
+- API compatibility mode (OpenAI-compatible, Anthropic-compatible, or auto-detect)
+- Base URL and API key
+- Model ID and optional alias
+
+Multiple custom endpoints can coexist — each gets its own endpoint ID.

package/docs/start/onboarding.md

@@ -0,0 +1,91 @@
+---
+summary: "First-run setup flow for QuantumClaw (macOS app)"
+read_when:
+  - Designing the macOS onboarding assistant
+  - Implementing auth or identity setup
+title: "Onboarding (macOS App)"
+sidebarTitle: "Onboarding: macOS App"
+---
+
+# Onboarding (macOS App)
+
+This doc describes the **current** first‑run setup flow. The goal is a
+smooth “day 0” experience: pick where the Gateway runs, connect auth, run the
+wizard, and let the agent bootstrap itself.
+For a general overview of onboarding paths, see [Onboarding Overview](/start/onboarding-overview).
+
+<Steps>
+<Step title="Approve macOS warning">
+<Frame>
+<img src="/assets/macos-onboarding/01-macos-warning.jpeg" alt="" />
+</Frame>
+</Step>
+<Step title="Approve find local networks">
+<Frame>
+<img src="/assets/macos-onboarding/02-local-networks.jpeg" alt="" />
+</Frame>
+</Step>
+<Step title="Welcome and security notice">
+<Frame caption="Read the security notice displayed and decide accordingly">
+<img src="/assets/macos-onboarding/03-security-notice.png" alt="" />
+</Frame>
+
+Security trust model:
+
+- By default, QuantumClaw is a personal agent: one trusted operator boundary.
+- Shared/multi-user setups require lock-down (split trust boundaries, keep tool access minimal, and follow [Security](/gateway/security)).
+- Local onboarding now defaults new configs to `tools.profile: "coding"` so fresh local setups keep filesystem/runtime tools without forcing the unrestricted `full` profile.
+- If hooks/webhooks or other untrusted content feeds are enabled, use a strong modern model tier and keep strict tool policy/sandboxing.
+
+</Step>
+<Step title="Local vs Remote">
+<Frame>
+<img src="/assets/macos-onboarding/04-choose-gateway.png" alt="" />
+</Frame>
+
+Where does the **Gateway** run?
+
+- **This Mac (Local only):** onboarding can configure auth and write credentials
+  locally.
+- **Remote (over SSH/Tailnet):** onboarding does **not** configure local auth;
+  credentials must exist on the gateway host.
+- **Configure later:** skip setup and leave the app unconfigured.
+
+<Tip>
+**Gateway auth tip:**
+
+- The wizard now generates a **token** even for loopback, so local WS clients must authenticate.
+- If you disable auth, any local process can connect; use that only on fully trusted machines.
+- Use a **token** for multi‑machine access or non‑loopback binds.
+
+</Tip>
+</Step>
+<Step title="Permissions">
+<Frame caption="Choose what permissions do you want to give QuantumClaw">
+<img src="/assets/macos-onboarding/05-permissions.png" alt="" />
+</Frame>
+
+Onboarding requests TCC permissions needed for:
+
+- Automation (AppleScript)
+- Notifications
+- Accessibility
+- Screen Recording
+- Microphone
+- Speech Recognition
+- Camera
+- Location
+
+</Step>
+<Step title="CLI">
+  <Info>This step is optional</Info>
+  The app can install the global `quantumclaw` CLI via npm/pnpm so terminal
+  workflows and launchd tasks work out of the box.
+</Step>
+<Step title="Onboarding Chat (dedicated session)">
+  After setup, the app opens a dedicated onboarding chat session so the agent can
+  introduce itself and guide next steps. This keeps first‑run guidance separate
+  from your normal conversation. See [Bootstrapping](/start/bootstrapping) for
+  what happens on the gateway host during the first agent run.
+</Step>
+</Steps>

package/docs/start/openclaw.md

@@ -0,0 +1,221 @@
+---
+summary: "End-to-end guide for running QuantumClaw as a personal assistant with safety cautions"
+read_when:
+  - Onboarding a new assistant instance
+  - Reviewing safety/permission implications
+title: "Personal Assistant Setup"
+---
+
+# Building a personal assistant with QuantumClaw
+
+QuantumClaw is a self-hosted gateway that connects WhatsApp, Telegram, Discord, iMessage, and more to AI agents. This guide covers the "personal assistant" setup: a dedicated WhatsApp number that behaves like your always-on AI assistant.
+
+## ⚠️ Safety first
+
+You’re putting an agent in a position to:
+
+- run commands on your machine (depending on your tool policy)
+- read/write files in your workspace
+- send messages back out via WhatsApp/Telegram/Discord/Mattermost (plugin)
+
+Start conservative:
+
+- Always set `channels.whatsapp.allowFrom` (never run open-to-the-world on your personal Mac).
+- Use a dedicated WhatsApp number for the assistant.
+- Heartbeats now default to every 30 minutes. Disable until you trust the setup by setting `agents.defaults.heartbeat.every: "0m"`.
+
+## Prerequisites
+
+- QuantumClaw installed and onboarded — see [Getting Started](/start/getting-started) if you haven't done this yet
+- A second phone number (SIM/eSIM/prepaid) for the assistant
+
+## The two-phone setup (recommended)
+
+You want this:
+
+```mermaid
+flowchart TB
+    A["<b>Your Phone (personal)<br></b><br>Your WhatsApp<br>+1-555-YOU"] -- message --> B["<b>Second Phone (assistant)<br></b><br>Assistant WA<br>+1-555-ASSIST"]
+    B -- linked via QR --> C["<b>Your Mac (quantumclaw)<br></b><br>AI agent"]
+```
+
+If you link your personal WhatsApp to QuantumClaw, every message to you becomes “agent input”. That’s rarely what you want.
+
+## 5-minute quick start
+
+1. Pair WhatsApp Web (shows QR; scan with the assistant phone):
+
+```bash
+quantumclaw channels login
+```
+
+2. Start the Gateway (leave it running):
+
+```bash
+quantumclaw gateway --port 18789
+```
+
+3. Put a minimal config in `~/.quantumclaw/quantumclaw.json`:
+
+```json5
+{
+  channels: { whatsapp: { allowFrom: ["+15555550123"] } },
+}
+```
+
+Now message the assistant number from your allowlisted phone.
+
+When onboarding finishes, we auto-open the dashboard and print a clean (non-tokenized) link. If it prompts for auth, paste the token from `gateway.auth.token` into Control UI settings. To reopen later: `quantumclaw dashboard`.
+
+## Give the agent a workspace (AGENTS)
+
+QuantumClaw reads operating instructions and “memory” from its workspace directory.
+
+By default, QuantumClaw uses `~/.quantumclaw/workspace` as the agent workspace, and will create it (plus starter `AGENTS.md`, `SOUL.md`, `TOOLS.md`, `IDENTITY.md`, `USER.md`, `HEARTBEAT.md`) automatically on setup/first agent run. `BOOTSTRAP.md` is only created when the workspace is brand new (it should not come back after you delete it). `MEMORY.md` is optional (not auto-created); when present, it is loaded for normal sessions. Subagent sessions only inject `AGENTS.md` and `TOOLS.md`.
+
+Tip: treat this folder like QuantumClaw’s “memory” and make it a git repo (ideally private) so your `AGENTS.md` + memory files are backed up. If git is installed, brand-new workspaces are auto-initialized.
+
+```bash
+quantumclaw setup
+```
+
+Full workspace layout + backup guide: [Agent workspace](/concepts/agent-workspace)
+Memory workflow: [Memory](/concepts/memory)
+
+Optional: choose a different workspace with `agents.defaults.workspace` (supports `~`).
+
+```json5
+{
+  agent: {
+    workspace: "~/.quantumclaw/workspace",
+  },
+}
+```
+
+If you already ship your own workspace files from a repo, you can disable bootstrap file creation entirely:
+
+```json5
+{
+  agent: {
+    skipBootstrap: true,
+  },
+}
+```
+
+## The config that turns it into "an assistant"
+
+QuantumClaw defaults to a good assistant setup, but you’ll usually want to tune:
+
+- persona/instructions in `SOUL.md`
+- thinking defaults (if desired)
+- heartbeats (once you trust it)
+
+Example:
+
+```json5
+{
+  logging: { level: "info" },
+  agent: {
+    model: "anthropic/claude-opus-4-6",
+    workspace: "~/.quantumclaw/workspace",
+    thinkingDefault: "high",
+    timeoutSeconds: 1800,
+    // Start with 0; enable later.
+    heartbeat: { every: "0m" },
+  },
+  channels: {
+    whatsapp: {
+      allowFrom: ["+15555550123"],
+      groups: {
+        "*": { requireMention: true },
+      },
+    },
+  },
+  routing: {
+    groupChat: {
+      mentionPatterns: ["@quantumclaw", "quantumclaw"],
+    },
+  },
+  session: {
+    scope: "per-sender",
+    resetTriggers: ["/new", "/reset"],
+    reset: {
+      mode: "daily",
+      atHour: 4,
+      idleMinutes: 10080,
+    },
+  },
+}
+```
+
+## Sessions and memory
+
+- Session files: `~/.quantumclaw/agents/<agentId>/sessions/{{SessionId}}.jsonl`
+- Session metadata (token usage, last route, etc): `~/.quantumclaw/agents/<agentId>/sessions/sessions.json` (legacy: `~/.quantumclaw/sessions/sessions.json`)
+- `/new` or `/reset` starts a fresh session for that chat (configurable via `resetTriggers`). If sent alone, the agent replies with a short hello to confirm the reset.
+- `/compact [instructions]` compacts the session context and reports the remaining context budget.
+
+## Heartbeats (proactive mode)
+
+By default, QuantumClaw runs a heartbeat every 30 minutes with the prompt:
+`Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.`
+Set `agents.defaults.heartbeat.every: "0m"` to disable.
+
+- If `HEARTBEAT.md` exists but is effectively empty (only blank lines and markdown headers like `# Heading`), QuantumClaw skips the heartbeat run to save API calls.
+- If the file is missing, the heartbeat still runs and the model decides what to do.
+- If the agent replies with `HEARTBEAT_OK` (optionally with short padding; see `agents.defaults.heartbeat.ackMaxChars`), QuantumClaw suppresses outbound delivery for that heartbeat.
+- By default, heartbeat delivery to DM-style `user:<id>` targets is allowed. Set `agents.defaults.heartbeat.directPolicy: "block"` to suppress direct-target delivery while keeping heartbeat runs active.
+- Heartbeats run full agent turns — shorter intervals burn more tokens.
+
+```json5
+{
+  agent: {
+    heartbeat: { every: "30m" },
+  },
+}
+```
+
+## Media in and out
+
+Inbound attachments (images/audio/docs) can be surfaced to your command via templates:
+
+- `{{MediaPath}}` (local temp file path)
+- `{{MediaUrl}}` (pseudo-URL)
+- `{{Transcript}}` (if audio transcription is enabled)
+
+Outbound attachments from the agent: include `MEDIA:<path-or-url>` on its own line (no spaces). Example:
+
+```
+Here’s the screenshot.
+MEDIA:https://example.com/screenshot.png
+```
+
+QuantumClaw extracts these and sends them as media alongside the text.
+
+For local paths, the default allowlist is intentionally narrow: the QuantumClaw temp
+root, the media cache, agent workspace paths, and sandbox-generated files. If you
+need broader local-file attachment roots, configure an explicit channel/plugin
+allowlist instead of relying on arbitrary host paths.
+
+## Operations checklist
+
+```bash
+quantumclaw status          # local status (creds, sessions, queued events)
+quantumclaw status --all    # full diagnosis (read-only, pasteable)
+quantumclaw status --deep   # adds gateway health probes (Telegram + Discord)
+quantumclaw health --json   # gateway health snapshot (WS)
+```
+
+Logs live under `/tmp/quantumclaw/` (default: `quantumclaw-YYYY-MM-DD.log`).
+
+## Next steps
+
+- WebChat: [WebChat](/web/webchat)
+- Gateway ops: [Gateway runbook](/gateway)
+- Cron + wakeups: [Cron jobs](/automation/cron-jobs)
+- macOS menu bar companion: [QuantumClaw macOS app](/platforms/macos)
+- iOS node app: [iOS app](/platforms/ios)
+- Android node app: [Android app](/platforms/android)
+- Windows status: [Windows (WSL2)](/platforms/windows)
+- Linux status: [Linux app](/platforms/linux)
+- Security: [Security](/gateway/security)

package/docs/start/quickstart.md

@@ -0,0 +1,22 @@
+---
+summary: "Quick start has moved to Getting Started."
+read_when:
+  - You are looking for the fastest setup steps
+  - You were sent here from an older link
+title: "Quick start"
+---
+
+# Quick start
+
+<Info>
+Quick start is now part of [Getting Started](/start/getting-started).
+</Info>
+
+<Columns>
+  <Card title="Getting Started" href="/start/getting-started">
+    Install QuantumClaw and run your first chat in minutes.
+  </Card>
+  <Card title="Onboarding (CLI)" href="/start/wizard">
+    Full CLI onboarding reference and advanced options.
+  </Card>
+</Columns>