@quantumclaw/quantumclaw 2026.3.22

package/docs/install/render.mdx

@@ -0,0 +1,169 @@
+---
+summary: "Deploy OpenClaw on Render with Infrastructure-as-Code"
+read_when:
+  - Deploying OpenClaw to Render
+  - You want a declarative cloud deploy with Render Blueprints
+title: "Render"
+---
+
+Deploy OpenClaw on Render using Infrastructure as Code. The included `render.yaml` Blueprint defines your entire stack declaratively, service, disk, environment variables, so you can deploy with a single click and version your infrastructure alongside your code.
+
+## Prerequisites
+
+- A [Render account](https://render.com) (free tier available)
+- An API key from your preferred [model provider](/providers)
+
+## Deploy with a Render Blueprint
+
+[Deploy to Render](https://render.com/deploy?repo=https://github.com/openclaw/openclaw)
+
+Clicking this link will:
+
+1. Create a new Render service from the `render.yaml` Blueprint at the root of this repo.
+2. Prompt you to set `SETUP_PASSWORD`
+3. Build the Docker image and deploy
+
+Once deployed, your service URL follows the pattern `https://<service-name>.onrender.com`.
+
+## Understanding the Blueprint
+
+Render Blueprints are YAML files that define your infrastructure. The `render.yaml` in this
+repository configures everything needed to run OpenClaw:
+
+```yaml
+services:
+  - type: web
+    name: openclaw
+    runtime: docker
+    plan: starter
+    healthCheckPath: /health
+    envVars:
+      - key: PORT
+        value: "8080"
+      - key: SETUP_PASSWORD
+        sync: false # prompts during deploy
+      - key: OPENCLAW_STATE_DIR
+        value: /data/.openclaw
+      - key: OPENCLAW_WORKSPACE_DIR
+        value: /data/workspace
+      - key: OPENCLAW_GATEWAY_TOKEN
+        generateValue: true # auto-generates a secure token
+    disk:
+      name: openclaw-data
+      mountPath: /data
+      sizeGB: 1
+```
+
+Key Blueprint features used:
+
+| Feature               | Purpose                                                    |
+| --------------------- | ---------------------------------------------------------- |
+| `runtime: docker`     | Builds from the repo's Dockerfile                          |
+| `healthCheckPath`     | Render monitors `/health` and restarts unhealthy instances |
+| `sync: false`         | Prompts for value during deploy (secrets)                  |
+| `generateValue: true` | Auto-generates a cryptographically secure value            |
+| `disk`                | Persistent storage that survives redeploys                 |
+
+## Choosing a plan
+
+| Plan      | Spin-down         | Disk          | Best for                      |
+| --------- | ----------------- | ------------- | ----------------------------- |
+| Free      | After 15 min idle | Not available | Testing, demos                |
+| Starter   | Never             | 1GB+          | Personal use, small teams     |
+| Standard+ | Never             | 1GB+          | Production, multiple channels |
+
+The Blueprint defaults to `starter`. To use free tier, change `plan: free` in your fork's
+`render.yaml` (but note: no persistent disk means config resets on each deploy).
+
+## After deployment
+
+### Complete web setup
+
+1. Navigate to `https://<your-service>.onrender.com/setup`
+2. Enter your `SETUP_PASSWORD`
+3. Select a model provider and paste your API key
+4. Optionally configure messaging channels (Telegram, Discord, Slack)
+5. Click **Run setup**
+
+### Access the Control UI
+
+The web dashboard is available at `https://<your-service>.onrender.com/openclaw`.
+
+## Render Dashboard features
+
+### Logs
+
+View real-time logs in **Dashboard → your service → Logs**. Filter by:
+
+- Build logs (Docker image creation)
+- Deploy logs (service startup)
+- Runtime logs (application output)
+
+### Shell access
+
+For debugging, open a shell session via **Dashboard → your service → Shell**. The persistent disk is mounted at `/data`.
+
+### Environment variables
+
+Modify variables in **Dashboard → your service → Environment**. Changes trigger an automatic redeploy.
+
+### Auto-deploy
+
+If you use the original OpenClaw repository, Render will not auto-deploy your OpenClaw. To update it, run a manual Blueprint sync from the dashboard.
+
+## Custom domain
+
+1. Go to **Dashboard → your service → Settings → Custom Domains**
+2. Add your domain
+3. Configure DNS as instructed (CNAME to `*.onrender.com`)
+4. Render provisions a TLS certificate automatically
+
+## Scaling
+
+Render supports horizontal and vertical scaling:
+
+- **Vertical**: Change the plan to get more CPU/RAM
+- **Horizontal**: Increase instance count (Standard plan and above)
+
+For OpenClaw, vertical scaling is usually sufficient. Horizontal scaling requires sticky sessions or external state management.
+
+## Backups and migration
+
+Export your configuration and workspace at any time:
+
+```
+https://<your-service>.onrender.com/setup/export
+```
+
+This downloads a portable backup you can restore on any OpenClaw host.
+
+## Troubleshooting
+
+### Service will not start
+
+Check the deploy logs in the Render Dashboard. Common issues:
+
+- Missing `SETUP_PASSWORD` — the Blueprint prompts for this, but verify it's set
+- Port mismatch — ensure `PORT=8080` matches the Dockerfile's exposed port
+
+### Slow cold starts (free tier)
+
+Free tier services spin down after 15 minutes of inactivity. The first request after spin-down takes a few seconds while the container starts. Upgrade to Starter plan for always-on.
+
+### Data loss after redeploy
+
+This happens on free tier (no persistent disk). Upgrade to a paid plan, or
+regularly export your config via `/setup/export`.
+
+### Health check failures
+
+Render expects a 200 response from `/health` within 30 seconds. If builds succeed but deploys fail, the service may be taking too long to start. Check:
+
+- Build logs for errors
+- Whether the container runs locally with `docker build && docker run`
+
+## Next steps
+
+- Set up messaging channels: [Channels](/channels)
+- Configure the Gateway: [Gateway configuration](/gateway/configuration)
+- Keep OpenClaw up to date: [Updating](/install/updating)

package/docs/install/uninstall.md

@@ -0,0 +1,128 @@
+---
+summary: "Uninstall QuantumClaw completely (CLI, service, state, workspace)"
+read_when:
+  - You want to remove QuantumClaw from a machine
+  - The gateway service is still running after uninstall
+title: "Uninstall"
+---
+
+# Uninstall
+
+Two paths:
+
+- **Easy path** if `quantumclaw` is still installed.
+- **Manual service removal** if the CLI is gone but the service is still running.
+
+## Easy path (CLI still installed)
+
+Recommended: use the built-in uninstaller:
+
+```bash
+quantumclaw uninstall
+```
+
+Non-interactive (automation / npx):
+
+```bash
+quantumclaw uninstall --all --yes --non-interactive
+npx -y quantumclaw uninstall --all --yes --non-interactive
+```
+
+Manual steps (same result):
+
+1. Stop the gateway service:
+
+```bash
+quantumclaw gateway stop
+```
+
+2. Uninstall the gateway service (launchd/systemd/schtasks):
+
+```bash
+quantumclaw gateway uninstall
+```
+
+3. Delete state + config:
+
+```bash
+rm -rf "${QUANTUMCLAW_STATE_DIR:-$HOME/.quantumclaw}"
+```
+
+If you set `QUANTUMCLAW_CONFIG_PATH` to a custom location outside the state dir, delete that file too.
+
+4. Delete your workspace (optional, removes agent files):
+
+```bash
+rm -rf ~/.quantumclaw/workspace
+```
+
+5. Remove the CLI install (pick the one you used):
+
+```bash
+npm rm -g quantumclaw
+pnpm remove -g quantumclaw
+bun remove -g quantumclaw
+```
+
+6. If you installed the macOS app:
+
+```bash
+rm -rf /Applications/QuantumClaw.app
+```
+
+Notes:
+
+- If you used profiles (`--profile` / `QUANTUMCLAW_PROFILE`), repeat step 3 for each state dir (defaults are `~/.quantumclaw-<profile>`).
+- In remote mode, the state dir lives on the **gateway host**, so run steps 1-4 there too.
+
+## Manual service removal (CLI not installed)
+
+Use this if the gateway service keeps running but `quantumclaw` is missing.
+
+### macOS (launchd)
+
+Default label is `ai.quantumclaw.gateway` (or `ai.quantumclaw.<profile>`; legacy `com.quantumclaw.*` may still exist):
+
+```bash
+launchctl bootout gui/$UID/ai.quantumclaw.gateway
+rm -f ~/Library/LaunchAgents/ai.quantumclaw.gateway.plist
+```
+
+If you used a profile, replace the label and plist name with `ai.quantumclaw.<profile>`. Remove any legacy `com.quantumclaw.*` plists if present.
+
+### Linux (systemd user unit)
+
+Default unit name is `quantumclaw-gateway.service` (or `quantumclaw-gateway-<profile>.service`):
+
+```bash
+systemctl --user disable --now quantumclaw-gateway.service
+rm -f ~/.config/systemd/user/quantumclaw-gateway.service
+systemctl --user daemon-reload
+```
+
+### Windows (Scheduled Task)
+
+Default task name is `QuantumClaw Gateway` (or `QuantumClaw Gateway (<profile>)`).
+The task script lives under your state dir.
+
+```powershell
+schtasks /Delete /F /TN "QuantumClaw Gateway"
+Remove-Item -Force "$env:USERPROFILE\.quantumclaw\gateway.cmd"
+```
+
+If you used a profile, delete the matching task name and `~\.quantumclaw-<profile>\gateway.cmd`.
+
+## Normal install vs source checkout
+
+### Normal install (install.sh / npm / pnpm / bun)
+
+If you used `https://quantumclaw.ai/install.sh` or `install.ps1`, the CLI was installed with `npm install -g quantumclaw@latest`.
+Remove it with `npm rm -g quantumclaw` (or `pnpm remove -g` / `bun remove -g` if you installed that way).
+
+### Source checkout (git clone)
+
+If you run from a repo checkout (`git clone` + `quantumclaw ...` / `bun run quantumclaw ...`):
+
+1. Uninstall the gateway service **before** deleting the repo (use the easy path above or manual service removal).
+2. Delete the repo directory.
+3. Remove state + workspace as shown above.

package/docs/install/updating.md

@@ -0,0 +1,128 @@
+---
+summary: "Updating QuantumClaw safely (global install or source), plus rollback strategy"
+read_when:
+  - Updating QuantumClaw
+  - Something breaks after an update
+title: "Updating"
+---
+
+# Updating
+
+Keep QuantumClaw up to date.
+
+## Recommended: `quantumclaw update`
+
+The fastest way to update. It detects your install type (npm or git), fetches the latest version, runs `quantumclaw doctor`, and restarts the gateway.
+
+```bash
+quantumclaw update
+```
+
+To switch channels or target a specific version:
+
+```bash
+quantumclaw update --channel beta
+quantumclaw update --tag main
+quantumclaw update --dry-run   # preview without applying
+```
+
+See [Development channels](/install/development-channels) for channel semantics.
+
+## Alternative: re-run the installer
+
+```bash
+curl -fsSL https://quantumclaw.ai/install.sh | bash
+```
+
+Add `--no-onboard` to skip onboarding. For source installs, pass `--install-method git --no-onboard`.
+
+## Alternative: manual npm or pnpm
+
+```bash
+npm i -g quantumclaw@latest
+```
+
+```bash
+pnpm add -g quantumclaw@latest
+```
+
+## Auto-updater
+
+The auto-updater is off by default. Enable it in `~/.quantumclaw/quantumclaw.json`:
+
+```json5
+{
+  update: {
+    channel: "stable",
+    auto: {
+      enabled: true,
+      stableDelayHours: 6,
+      stableJitterHours: 12,
+      betaCheckIntervalHours: 1,
+    },
+  },
+}
+```
+
+| Channel  | Behavior                                                                                                      |
+| -------- | ------------------------------------------------------------------------------------------------------------- |
+| `stable` | Waits `stableDelayHours`, then applies with deterministic jitter across `stableJitterHours` (spread rollout). |
+| `beta`   | Checks every `betaCheckIntervalHours` (default: hourly) and applies immediately.                              |
+| `dev`    | No automatic apply. Use `quantumclaw update` manually.                                                           |
+
+The gateway also logs an update hint on startup (disable with `update.checkOnStart: false`).
+
+## After updating
+
+<Steps>
+
+### Run doctor
+
+```bash
+quantumclaw doctor
+```
+
+Migrates config, audits DM policies, and checks gateway health. Details: [Doctor](/gateway/doctor)
+
+### Restart the gateway
+
+```bash
+quantumclaw gateway restart
+```
+
+### Verify
+
+```bash
+quantumclaw health
+```
+
+</Steps>
+
+## Rollback
+
+### Pin a version (npm)
+
+```bash
+npm i -g quantumclaw@<version>
+quantumclaw doctor
+quantumclaw gateway restart
+```
+
+Tip: `npm view quantumclaw version` shows the current published version.
+
+### Pin a commit (source)
+
+```bash
+git fetch origin
+git checkout "$(git rev-list -n 1 --before=\"2026-01-01\" origin/main)"
+pnpm install && pnpm build
+quantumclaw gateway restart
+```
+
+To return to latest: `git checkout main && git pull`.
+
+## If you are stuck
+
+- Run `quantumclaw doctor` again and read the output carefully.
+- Check: [Troubleshooting](/gateway/troubleshooting)
+- Ask in Discord: [https://discord.gg/clawd](https://discord.gg/clawd)

package/docs/ja-JP/index.md

@@ -0,0 +1,186 @@
+---
+read_when:
+  - 新規ユーザーにQuantumClawを紹介するとき
+summary: QuantumClawは、あらゆるOSで動作するAIエージェント向けのマルチチャネルgatewayです。
+title: QuantumClaw
+x-i18n:
+  generated_at: "2026-02-08T17:15:47Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: fc8babf7885ef91d526795051376d928599c4cf8aff75400138a0d7d9fa3b75f
+  source_path: index.md
+  workflow: 15
+---
+
+# QuantumClaw 🦞
+
+<p align="center">
+    <img
+        src="/assets/quantumclaw-logo-text-dark.png"
+        alt="QuantumClaw"
+        width="500"
+        class="dark:hidden"
+    />
+    <img
+        src="/assets/quantumclaw-logo-text.png"
+        alt="QuantumClaw"
+        width="500"
+        class="hidden dark:block"
+    />
+</p>
+
+> _「EXFOLIATE! EXFOLIATE!」_ — たぶん宇宙ロブスター
+
+<p align="center">
+  <strong>WhatsApp、Telegram、Discord、iMessageなどに対応した、あらゆるOS向けのAIエージェントgateway。</strong><br />
+  メッセージを送信すれば、ポケットからエージェントの応答を受け取れます。プラグインでMattermostなどを追加できます。
+</p>
+
+<Columns>
+  <Card title="はじめに" href="/start/getting-started" icon="rocket">
+    QuantumClawをインストールし、数分でGatewayを起動できます。
+  </Card>
+  <Card title="ウィザードを実行" href="/start/wizard" icon="sparkles">
+    `quantumclaw onboard`とペアリングフローによるガイド付きセットアップ。
+  </Card>
+  <Card title="Control UIを開く" href="/web/control-ui" icon="layout-dashboard">
+    チャット、設定、セッション用のブラウザダッシュボードを起動します。
+  </Card>
+</Columns>
+
+QuantumClawは、単一のGatewayプロセスを通じてチャットアプリをPiのようなコーディングエージェントに接続します。QuantumClawアシスタントを駆動し、ローカルまたはリモートのセットアップをサポートします。
+
+## 仕組み
+
+```mermaid
+flowchart LR
+  A["チャットアプリ + プラグイン"] --> B["Gateway"]
+  B --> C["Piエージェント"]
+  B --> D["CLI"]
+  B --> E["Web Control UI"]
+  B --> F["macOSアプリ"]
+  B --> G["iOSおよびAndroidノード"]
+```
+
+Gatewayは、セッション、ルーティング、チャネル接続の信頼できる唯一の情報源です。
+
+## 主な機能
+
+<Columns>
+  <Card title="マルチチャネルgateway" icon="network">
+    単一のGatewayプロセスでWhatsApp、Telegram、Discord、iMessageに対応。
+  </Card>
+  <Card title="プラグインチャネル" icon="plug">
+    拡張パッケージでMattermostなどを追加。
+  </Card>
+  <Card title="マルチエージェントルーティング" icon="route">
+    エージェント、ワークスペース、送信者ごとに分離されたセッション。
+  </Card>
+  <Card title="メディアサポート" icon="image">
+    画像、音声、ドキュメントの送受信。
+  </Card>
+  <Card title="Web Control UI" icon="monitor">
+    チャット、設定、セッション、ノード用のブラウザダッシュボード。
+  </Card>
+  <Card title="モバイルノード" icon="smartphone">
+    Canvas対応のiOSおよびAndroidノードをペアリング。
+  </Card>
+</Columns>
+
+## クイックスタート
+
+<Steps>
+  <Step title="QuantumClawをインストール">
+    ```bash
+    npm install -g quantumclaw@latest
+    ```
+  </Step>
+  <Step title="オンボーディングとサービスのインストール">
+    ```bash
+    quantumclaw onboard --install-daemon
+    ```
+  </Step>
+  <Step title="WhatsAppをペアリングしてGatewayを起動">
+    ```bash
+    quantumclaw channels login
+    quantumclaw gateway --port 18789
+    ```
+  </Step>
+</Steps>
+
+完全なインストールと開発セットアップが必要ですか？[クイックスタート](/start/quickstart)をご覧ください。
+
+## ダッシュボード
+
+Gatewayの起動後、ブラウザでControl UIを開きます。
+
+- ローカルデフォルト: [http://127.0.0.1:18789/](http://127.0.0.1:18789/)
+- リモートアクセス: [Webサーフェス](/web)および[Tailscale](/gateway/tailscale)
+
+<p align="center">
+  <img src="/whatsapp-quantumclaw.jpg" alt="QuantumClaw" width="420" />
+</p>
+
+## 設定（オプション）
+
+設定は`~/.quantumclaw/quantumclaw.json`にあります。
+
+- **何もしなければ**、QuantumClawはバンドルされたPiバイナリをRPCモードで使用し、送信者ごとのセッションを作成します。
+- 制限を設けたい場合は、`channels.whatsapp.allowFrom`と（グループの場合）メンションルールから始めてください。
+
+例：
+
+```json5
+{
+  channels: {
+    whatsapp: {
+      allowFrom: ["+15555550123"],
+      groups: { "*": { requireMention: true } },
+    },
+  },
+  messages: { groupChat: { mentionPatterns: ["@quantumclaw"] } },
+}
+```
+
+## ここから始める
+
+<Columns>
+  <Card title="ドキュメントハブ" href="/start/hubs" icon="book-open">
+    ユースケース別に整理されたすべてのドキュメントとガイド。
+  </Card>
+  <Card title="設定" href="/gateway/configuration" icon="settings">
+    Gatewayのコア設定、トークン、プロバイダー設定。
+  </Card>
+  <Card title="リモートアクセス" href="/gateway/remote" icon="globe">
+    SSHおよびtailnetアクセスパターン。
+  </Card>
+  <Card title="チャネル" href="/channels/telegram" icon="message-square">
+    WhatsApp、Telegram、Discordなどのチャネル固有のセットアップ。
+  </Card>
+  <Card title="ノード" href="/nodes" icon="smartphone">
+    ペアリングとCanvas対応のiOSおよびAndroidノード。
+  </Card>
+  <Card title="ヘルプ" href="/help" icon="life-buoy">
+    一般的な修正とトラブルシューティングのエントリーポイント。
+  </Card>
+</Columns>
+
+## 詳細
+
+<Columns>
+  <Card title="全機能リスト" href="/concepts/features" icon="list">
+    チャネル、ルーティング、メディア機能の完全な一覧。
+  </Card>
+  <Card title="マルチエージェントルーティング" href="/concepts/multi-agent" icon="route">
+    ワークスペースの分離とエージェントごとのセッション。
+  </Card>
+  <Card title="セキュリティ" href="/gateway/security" icon="shield">
+    トークン、許可リスト、安全制御。
+  </Card>
+  <Card title="トラブルシューティング" href="/gateway/troubleshooting" icon="wrench">
+    Gatewayの診断と一般的なエラー。
+  </Card>
+  <Card title="概要とクレジット" href="/reference/credits" icon="info">
+    プロジェクトの起源、貢献者、ライセンス。
+  </Card>
+</Columns>