From ba3158e01a899d5300d0863108cf9cb48aad68fb Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 12 Jan 2026 08:00:38 +0000 Subject: [PATCH] docs: fix README docs links --- README.md | 194 +++++++++++++++++++++++++++--------------------------- 1 file changed, 97 insertions(+), 97 deletions(-) diff --git a/README.md b/README.md index 64b3c35fc..fcc6dff74 100644 --- a/README.md +++ b/README.md @@ -20,22 +20,22 @@ It answers you on the providers you already use (WhatsApp, Telegram, Slack, Disc If you want a personal, single-user assistant that feels local, fast, and always-on, this is it. -[Website](https://clawdbot.com) · [Docs](https://docs.clawd.bot) · [Getting Started](https://docs.clawd.bot/getting-started) · [Updating](https://docs.clawd.bot/updating) · [Showcase](https://docs.clawd.bot/showcase) · [FAQ](https://docs.clawd.bot/faq) · [Wizard](https://docs.clawd.bot/wizard) · [Nix](https://github.com/clawdbot/nix-clawdbot) · [Docker](https://docs.clawd.bot/docker) · [Discord](https://discord.gg/clawd) +[Website](https://clawdbot.com) · [Docs](https://docs.clawd.bot) · [Getting Started](https://docs.clawd.bot/start/getting-started) · [Updating](https://docs.clawd.bot/install/updating) · [Showcase](https://docs.clawd.bot/start/showcase) · [FAQ](https://docs.clawd.bot/start/faq) · [Wizard](https://docs.clawd.bot/start/wizard) · [Nix](https://github.com/clawdbot/nix-clawdbot) · [Docker](https://docs.clawd.bot/install/docker) · [Discord](https://discord.gg/clawd) Preferred setup: run the onboarding wizard (`clawdbot onboard`). It walks through gateway, workspace, providers, and skills. The CLI wizard is the recommended path and works on **macOS, Linux, and Windows (via WSL2; strongly recommended)**. Works with npm, pnpm, or bun. -New install? Start here: [Getting started](https://docs.clawd.bot/getting-started) +New install? Start here: [Getting started](https://docs.clawd.bot/start/getting-started) **Subscriptions (OAuth):** - **[Anthropic](https://www.anthropic.com/)** (Claude Pro/Max) - **[OpenAI](https://openai.com/)** (ChatGPT/Codex) -Model note: while any model is supported, I strongly recommend **Anthropic Pro/Max (100/200) + Opus 4.5** for long‑context strength and better prompt‑injection resistance. See [Onboarding](https://docs.clawd.bot/onboarding). +Model note: while any model is supported, I strongly recommend **Anthropic Pro/Max (100/200) + Opus 4.5** for long‑context strength and better prompt‑injection resistance. See [Onboarding](https://docs.clawd.bot/start/onboarding). ## Models (selection + auth) -- Models config + CLI: [Models](https://docs.clawd.bot/models) -- Auth profile rotation (OAuth vs API keys) + fallbacks: [Model failover](https://docs.clawd.bot/model-failover) +- Models config + CLI: [Models](https://docs.clawd.bot/concepts/models) +- Auth profile rotation (OAuth vs API keys) + fallbacks: [Model failover](https://docs.clawd.bot/concepts/model-failover) ## Install (recommended) @@ -54,7 +54,7 @@ The wizard installs the Gateway daemon (launchd/systemd user service) so it stay Runtime: **Node ≥22**. -Full beginner guide (auth, pairing, providers): [Getting started](https://docs.clawd.bot/getting-started) +Full beginner guide (auth, pairing, providers): [Getting started](https://docs.clawd.bot/start/getting-started) ```bash clawdbot onboard --install-daemon @@ -68,7 +68,7 @@ clawdbot message send --to +1234567890 --message "Hello from Clawdbot" clawdbot agent --message "Ship checklist" --thinking high ``` -Upgrading? [Updating guide](https://docs.clawd.bot/updating) (and run `clawdbot doctor`). +Upgrading? [Updating guide](https://docs.clawd.bot/install/updating) (and run `clawdbot doctor`). ## From source (development) @@ -94,7 +94,7 @@ Note: `pnpm clawdbot ...` runs TypeScript directly (via `tsx`). `pnpm build` pro Clawdbot connects to real messaging surfaces. Treat inbound DMs as **untrusted input**. -Full security guide: [Security](https://docs.clawd.bot/security) +Full security guide: [Security](https://docs.clawd.bot/gateway/security) Default behavior on Telegram/WhatsApp/Signal/iMessage/Discord/Slack: - **DM pairing** (`dmPolicy="pairing"` / `discord.dm.policy="pairing"` / `slack.dm.policy="pairing"`): unknown senders receive a short pairing code and the bot does not process their message. @@ -106,51 +106,51 @@ Run `clawdbot doctor` to surface risky/misconfigured DM policies. ## Highlights - **[Local-first Gateway](https://docs.clawd.bot/gateway)** — single control plane for sessions, providers, tools, and events. -- **[Multi-provider inbox](https://docs.clawd.bot/surface)** — WhatsApp, Telegram, Slack, Discord, Signal, iMessage, WebChat, macOS, iOS/Android. -- **[Multi-agent routing](https://docs.clawd.bot/configuration)** — route inbound providers/accounts/peers to isolated agents (workspaces + per-agent sessions). -- **[Voice Wake](https://docs.clawd.bot/voicewake) + [Talk Mode](https://docs.clawd.bot/talk)** — always-on speech for macOS/iOS/Android with ElevenLabs. -- **[Live Canvas](https://docs.clawd.bot/mac/canvas)** — agent-driven visual workspace with [A2UI](https://docs.clawd.bot/mac/canvas#canvas-a2ui). +- **[Multi-provider inbox](https://docs.clawd.bot/providers)** — WhatsApp, Telegram, Slack, Discord, Signal, iMessage, WebChat, macOS, iOS/Android. +- **[Multi-agent routing](https://docs.clawd.bot/gateway/configuration)** — route inbound providers/accounts/peers to isolated agents (workspaces + per-agent sessions). +- **[Voice Wake](https://docs.clawd.bot/nodes/voicewake) + [Talk Mode](https://docs.clawd.bot/nodes/talk)** — always-on speech for macOS/iOS/Android with ElevenLabs. +- **[Live Canvas](https://docs.clawd.bot/platforms/mac/canvas)** — agent-driven visual workspace with [A2UI](https://docs.clawd.bot/platforms/mac/canvas#canvas-a2ui). - **[First-class tools](https://docs.clawd.bot/tools)** — browser, canvas, nodes, cron, sessions, and Discord/Slack actions. -- **[Companion apps](https://docs.clawd.bot/macos)** — macOS menu bar app + iOS/Android [nodes](https://docs.clawd.bot/nodes). -- **[Onboarding](https://docs.clawd.bot/wizard) + [skills](https://docs.clawd.bot/skills)** — wizard-driven setup with bundled/managed/workspace skills. +- **[Companion apps](https://docs.clawd.bot/platforms/macos)** — macOS menu bar app + iOS/Android [nodes](https://docs.clawd.bot/nodes). +- **[Onboarding](https://docs.clawd.bot/start/wizard) + [skills](https://docs.clawd.bot/tools/skills)** — wizard-driven setup with bundled/managed/workspace skills. ## Everything we built so far ### Core platform -- [Gateway WS control plane](https://docs.clawd.bot/gateway) with sessions, presence, config, cron, webhooks, [Control UI](https://docs.clawd.bot/web), and [Canvas host](https://docs.clawd.bot/mac/canvas#canvas-a2ui). -- [CLI surface](https://docs.clawd.bot/agent-send): gateway, agent, send, [wizard](https://docs.clawd.bot/wizard), and [doctor](https://docs.clawd.bot/doctor). -- [Pi agent runtime](https://docs.clawd.bot/agent) in RPC mode with tool streaming and block streaming. -- [Session model](https://docs.clawd.bot/session): `main` for direct chats, group isolation, activation modes, queue modes, reply-back. Group rules: [Groups](https://docs.clawd.bot/groups). -- [Media pipeline](https://docs.clawd.bot/images): images/audio/video, transcription hooks, size caps, temp file lifecycle. Audio details: [Audio](https://docs.clawd.bot/audio). +- [Gateway WS control plane](https://docs.clawd.bot/gateway) with sessions, presence, config, cron, webhooks, [Control UI](https://docs.clawd.bot/web), and [Canvas host](https://docs.clawd.bot/platforms/mac/canvas#canvas-a2ui). +- [CLI surface](https://docs.clawd.bot/tools/agent-send): gateway, agent, send, [wizard](https://docs.clawd.bot/start/wizard), and [doctor](https://docs.clawd.bot/gateway/doctor). +- [Pi agent runtime](https://docs.clawd.bot/concepts/agent) in RPC mode with tool streaming and block streaming. +- [Session model](https://docs.clawd.bot/concepts/session): `main` for direct chats, group isolation, activation modes, queue modes, reply-back. Group rules: [Groups](https://docs.clawd.bot/concepts/groups). +- [Media pipeline](https://docs.clawd.bot/nodes/images): images/audio/video, transcription hooks, size caps, temp file lifecycle. Audio details: [Audio](https://docs.clawd.bot/nodes/audio). ### Providers -- [Providers](https://docs.clawd.bot/surface): [WhatsApp](https://docs.clawd.bot/whatsapp) (Baileys), [Telegram](https://docs.clawd.bot/telegram) (grammY), [Slack](https://docs.clawd.bot/slack) (Bolt), [Discord](https://docs.clawd.bot/discord) (discord.js), [Signal](https://docs.clawd.bot/signal) (signal-cli), [iMessage](https://docs.clawd.bot/imessage) (imsg), [WebChat](https://docs.clawd.bot/webchat). -- [Group routing](https://docs.clawd.bot/group-messages): mention gating, reply tags, per-provider chunking and routing. Provider rules: [Providers](https://docs.clawd.bot/surface). +- [Providers](https://docs.clawd.bot/providers): [WhatsApp](https://docs.clawd.bot/providers/whatsapp) (Baileys), [Telegram](https://docs.clawd.bot/providers/telegram) (grammY), [Slack](https://docs.clawd.bot/providers/slack) (Bolt), [Discord](https://docs.clawd.bot/providers/discord) (discord.js), [Signal](https://docs.clawd.bot/providers/signal) (signal-cli), [iMessage](https://docs.clawd.bot/providers/imessage) (imsg), [WebChat](https://docs.clawd.bot/web/webchat). +- [Group routing](https://docs.clawd.bot/concepts/group-messages): mention gating, reply tags, per-provider chunking and routing. Provider rules: [Providers](https://docs.clawd.bot/providers). ### Apps + nodes -- [macOS app](https://docs.clawd.bot/macos): menu bar control plane, [Voice Wake](https://docs.clawd.bot/voicewake)/PTT, [Talk Mode](https://docs.clawd.bot/talk) overlay, [WebChat](https://docs.clawd.bot/webchat), debug tools, [remote gateway](https://docs.clawd.bot/remote) control. -- [iOS node](https://docs.clawd.bot/ios): [Canvas](https://docs.clawd.bot/mac/canvas), [Voice Wake](https://docs.clawd.bot/voicewake), [Talk Mode](https://docs.clawd.bot/talk), camera, screen recording, Bonjour pairing. -- [Android node](https://docs.clawd.bot/android): [Canvas](https://docs.clawd.bot/mac/canvas), [Talk Mode](https://docs.clawd.bot/talk), camera, screen recording, optional SMS. +- [macOS app](https://docs.clawd.bot/platforms/macos): menu bar control plane, [Voice Wake](https://docs.clawd.bot/nodes/voicewake)/PTT, [Talk Mode](https://docs.clawd.bot/nodes/talk) overlay, [WebChat](https://docs.clawd.bot/web/webchat), debug tools, [remote gateway](https://docs.clawd.bot/gateway/remote) control. +- [iOS node](https://docs.clawd.bot/platforms/ios): [Canvas](https://docs.clawd.bot/platforms/mac/canvas), [Voice Wake](https://docs.clawd.bot/nodes/voicewake), [Talk Mode](https://docs.clawd.bot/nodes/talk), camera, screen recording, Bonjour pairing. +- [Android node](https://docs.clawd.bot/platforms/android): [Canvas](https://docs.clawd.bot/platforms/mac/canvas), [Talk Mode](https://docs.clawd.bot/nodes/talk), camera, screen recording, optional SMS. - [macOS node mode](https://docs.clawd.bot/nodes): system.run/notify + canvas/camera exposure. ### Tools + automation -- [Browser control](https://docs.clawd.bot/browser): dedicated clawd Chrome/Chromium, snapshots, actions, uploads, profiles. -- [Canvas](https://docs.clawd.bot/mac/canvas): [A2UI](https://docs.clawd.bot/mac/canvas#canvas-a2ui) push/reset, eval, snapshot. -- [Nodes](https://docs.clawd.bot/nodes): camera snap/clip, screen record, [location.get](https://docs.clawd.bot/location-command), notifications. -- [Cron + wakeups](https://docs.clawd.bot/cron); [webhooks](https://docs.clawd.bot/webhook); [Gmail Pub/Sub](https://docs.clawd.bot/gmail-pubsub). -- [Skills platform](https://docs.clawd.bot/skills): bundled, managed, and workspace skills with install gating + UI. +- [Browser control](https://docs.clawd.bot/tools/browser): dedicated clawd Chrome/Chromium, snapshots, actions, uploads, profiles. +- [Canvas](https://docs.clawd.bot/platforms/mac/canvas): [A2UI](https://docs.clawd.bot/platforms/mac/canvas#canvas-a2ui) push/reset, eval, snapshot. +- [Nodes](https://docs.clawd.bot/nodes): camera snap/clip, screen record, [location.get](https://docs.clawd.bot/nodes/location-command), notifications. +- [Cron + wakeups](https://docs.clawd.bot/automation/cron-jobs); [webhooks](https://docs.clawd.bot/automation/webhook); [Gmail Pub/Sub](https://docs.clawd.bot/automation/gmail-pubsub). +- [Skills platform](https://docs.clawd.bot/tools/skills): bundled, managed, and workspace skills with install gating + UI. ### Runtime + safety -- [Provider routing](https://docs.clawd.bot/provider-routing), [retry policy](https://docs.clawd.bot/retry), and [streaming/chunking](https://docs.clawd.bot/streaming). -- [Presence](https://docs.clawd.bot/presence), [typing indicators](https://docs.clawd.bot/typing-indicators), and [usage tracking](https://docs.clawd.bot/usage-tracking). -- [Models](https://docs.clawd.bot/models), [model failover](https://docs.clawd.bot/model-failover), and [session pruning](https://docs.clawd.bot/session-pruning). -- [Security](https://docs.clawd.bot/security) and [troubleshooting](https://docs.clawd.bot/troubleshooting). +- [Provider routing](https://docs.clawd.bot/concepts/provider-routing), [retry policy](https://docs.clawd.bot/concepts/retry), and [streaming/chunking](https://docs.clawd.bot/concepts/streaming). +- [Presence](https://docs.clawd.bot/concepts/presence), [typing indicators](https://docs.clawd.bot/concepts/typing-indicators), and [usage tracking](https://docs.clawd.bot/concepts/usage-tracking). +- [Models](https://docs.clawd.bot/concepts/models), [model failover](https://docs.clawd.bot/concepts/model-failover), and [session pruning](https://docs.clawd.bot/concepts/session-pruning). +- [Security](https://docs.clawd.bot/gateway/security) and [troubleshooting](https://docs.clawd.bot/providers/troubleshooting). ### Ops + packaging -- [Control UI](https://docs.clawd.bot/web) + [WebChat](https://docs.clawd.bot/webchat) served directly from the Gateway. -- [Tailscale Serve/Funnel](https://docs.clawd.bot/tailscale) or [SSH tunnels](https://docs.clawd.bot/remote) with token/password auth. -- [Nix mode](https://docs.clawd.bot/nix) for declarative config; [Docker](https://docs.clawd.bot/docker)-based installs. -- [Doctor](https://docs.clawd.bot/doctor) migrations, [logging](https://docs.clawd.bot/logging). +- [Control UI](https://docs.clawd.bot/web) + [WebChat](https://docs.clawd.bot/web/webchat) served directly from the Gateway. +- [Tailscale Serve/Funnel](https://docs.clawd.bot/gateway/tailscale) or [SSH tunnels](https://docs.clawd.bot/gateway/remote) with token/password auth. +- [Nix mode](https://docs.clawd.bot/install/nix) for declarative config; [Docker](https://docs.clawd.bot/install/docker)-based installs. +- [Doctor](https://docs.clawd.bot/gateway/doctor) migrations, [logging](https://docs.clawd.bot/logging). ## How it works (short) @@ -173,11 +173,11 @@ WhatsApp / Telegram / Slack / Discord / Signal / iMessage / WebChat ## Key subsystems -- **[Gateway WebSocket network](https://docs.clawd.bot/architecture)** — single WS control plane for clients, tools, and events (plus ops: [Gateway runbook](https://docs.clawd.bot/gateway)). -- **[Tailscale exposure](https://docs.clawd.bot/tailscale)** — Serve/Funnel for the Gateway dashboard + WS (remote access: [Remote](https://docs.clawd.bot/remote)). -- **[Browser control](https://docs.clawd.bot/browser)** — clawd‑managed Chrome/Chromium with CDP control. -- **[Canvas + A2UI](https://docs.clawd.bot/mac/canvas)** — agent‑driven visual workspace (A2UI host: [Canvas/A2UI](https://docs.clawd.bot/mac/canvas#canvas-a2ui)). -- **[Voice Wake](https://docs.clawd.bot/voicewake) + [Talk Mode](https://docs.clawd.bot/talk)** — always‑on speech and continuous conversation. +- **[Gateway WebSocket network](https://docs.clawd.bot/concepts/architecture)** — single WS control plane for clients, tools, and events (plus ops: [Gateway runbook](https://docs.clawd.bot/gateway)). +- **[Tailscale exposure](https://docs.clawd.bot/gateway/tailscale)** — Serve/Funnel for the Gateway dashboard + WS (remote access: [Remote](https://docs.clawd.bot/gateway/remote)). +- **[Browser control](https://docs.clawd.bot/tools/browser)** — clawd‑managed Chrome/Chromium with CDP control. +- **[Canvas + A2UI](https://docs.clawd.bot/platforms/mac/canvas)** — agent‑driven visual workspace (A2UI host: [Canvas/A2UI](https://docs.clawd.bot/platforms/mac/canvas#canvas-a2ui)). +- **[Voice Wake](https://docs.clawd.bot/nodes/voicewake) + [Talk Mode](https://docs.clawd.bot/nodes/talk)** — always‑on speech and continuous conversation. - **[Nodes](https://docs.clawd.bot/nodes)** — Canvas, camera snap/clip, screen record, `location.get`, notifications, plus macOS‑only `system.run`/`system.notify`. ## Tailscale access (Gateway dashboard) @@ -194,7 +194,7 @@ Notes: - Funnel refuses to start unless `gateway.auth.mode: "password"` is set. - Optional: `gateway.tailscale.resetOnExit` to undo Serve/Funnel on shutdown. -Details: [Tailscale guide](https://docs.clawd.bot/tailscale) · [Web surfaces](https://docs.clawd.bot/web) +Details: [Tailscale guide](https://docs.clawd.bot/gateway/tailscale) · [Web surfaces](https://docs.clawd.bot/web) ## Remote Gateway (Linux is great) @@ -204,7 +204,7 @@ It’s perfectly fine to run the Gateway on a small Linux instance. Clients (mac - **Device nodes** run device‑local actions (`system.run`, camera, screen recording, notifications) via `node.invoke`. In short: exec runs where the Gateway lives; device actions run where the device lives. -Details: [Remote access](https://docs.clawd.bot/remote) · [Nodes](https://docs.clawd.bot/nodes) · [Security](https://docs.clawd.bot/security) +Details: [Remote access](https://docs.clawd.bot/gateway/remote) · [Nodes](https://docs.clawd.bot/nodes) · [Security](https://docs.clawd.bot/gateway/security) ## macOS permissions via the Gateway protocol @@ -219,7 +219,7 @@ Elevated bash (host permissions) is separate from macOS TCC: - Use `/elevated on|off` to toggle per‑session elevated access when enabled + allowlisted. - Gateway persists the per‑session toggle via `sessions.patch` (WS method) alongside `thinkingLevel`, `verboseLevel`, `model`, `sendPolicy`, and `groupActivation`. -Details: [Nodes](https://docs.clawd.bot/nodes) · [macOS app](https://docs.clawd.bot/macos) · [Gateway protocol](https://docs.clawd.bot/architecture) +Details: [Nodes](https://docs.clawd.bot/nodes) · [macOS app](https://docs.clawd.bot/platforms/macos) · [Gateway protocol](https://docs.clawd.bot/concepts/architecture) ## Agent to Agent (sessions_* tools) @@ -228,7 +228,7 @@ Details: [Nodes](https://docs.clawd.bot/nodes) · [macOS app](https://docs.clawd - `sessions_history` — fetch transcript logs for a session. - `sessions_send` — message another session; optional reply‑back ping‑pong + announce step (`REPLY_SKIP`, `ANNOUNCE_SKIP`). -Details: [Session tools](https://docs.clawd.bot/session-tool) +Details: [Session tools](https://docs.clawd.bot/concepts/session-tool) ## Skills registry (ClawdHub) @@ -275,13 +275,13 @@ Note: signed builds required for macOS permissions to stick across rebuilds (see - Voice trigger forwarding + Canvas surface. - Controlled via `clawdbot nodes …`. -Runbook: [iOS connect](https://docs.clawd.bot/ios). +Runbook: [iOS connect](https://docs.clawd.bot/platforms/ios). ### Android node (optional) - Pairs via the same Bridge + pairing flow as iOS. - Exposes Canvas, Camera, and Screen capture commands. -- Runbook: [Android connect](https://docs.clawd.bot/android). +- Runbook: [Android connect](https://docs.clawd.bot/platforms/android). ## Agent workspace + skills @@ -301,7 +301,7 @@ Minimal `~/.clawdbot/clawdbot.json` (model + defaults): } ``` -[Full configuration reference (all keys + examples).](https://docs.clawd.bot/configuration) +[Full configuration reference (all keys + examples).](https://docs.clawd.bot/gateway/configuration) ## Security model (important) @@ -309,15 +309,15 @@ Minimal `~/.clawdbot/clawdbot.json` (model + defaults): - **Group/channel safety:** set `agents.defaults.sandbox.mode: "non-main"` to run **non‑main sessions** (groups/channels) inside per‑session Docker sandboxes; bash then runs in Docker for those sessions. - **Sandbox defaults:** allowlist `bash`, `process`, `read`, `write`, `edit`, `sessions_list`, `sessions_history`, `sessions_send`, `sessions_spawn`; denylist `browser`, `canvas`, `nodes`, `cron`, `discord`, `gateway`. -Details: [Security guide](https://docs.clawd.bot/security) · [Docker + sandboxing](https://docs.clawd.bot/docker) · [Sandbox config](https://docs.clawd.bot/configuration) +Details: [Security guide](https://docs.clawd.bot/gateway/security) · [Docker + sandboxing](https://docs.clawd.bot/install/docker) · [Sandbox config](https://docs.clawd.bot/gateway/configuration) -### [WhatsApp](https://docs.clawd.bot/whatsapp) +### [WhatsApp](https://docs.clawd.bot/providers/whatsapp) - Link the device: `pnpm clawdbot providers login` (stores creds in `~/.clawdbot/credentials`). - Allowlist who can talk to the assistant via `whatsapp.allowFrom`. - If `whatsapp.groups` is set, it becomes a group allowlist; include `"*"` to allow all. -### [Telegram](https://docs.clawd.bot/telegram) +### [Telegram](https://docs.clawd.bot/providers/telegram) - Set `TELEGRAM_BOT_TOKEN` or `telegram.botToken` (env wins). - Optional: set `telegram.groups` (with `telegram.groups."*".requireMention`); when set, it is a group allowlist (include `"*"` to allow all). Also `telegram.allowFrom` or `telegram.webhookUrl` as needed. @@ -330,11 +330,11 @@ Details: [Security guide](https://docs.clawd.bot/security) · [Docker + sandboxi } ``` -### [Slack](https://docs.clawd.bot/slack) +### [Slack](https://docs.clawd.bot/providers/slack) - Set `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN` (or `slack.botToken` + `slack.appToken`). -### [Discord](https://docs.clawd.bot/discord) +### [Discord](https://docs.clawd.bot/providers/discord) - Set `DISCORD_BOT_TOKEN` or `discord.token` (env wins). - Optional: set `commands.native`, `commands.text`, or `commands.useAccessGroups`, plus `discord.dm.allowFrom`, `discord.guilds`, or `discord.mediaMaxMb` as needed. @@ -347,16 +347,16 @@ Details: [Security guide](https://docs.clawd.bot/security) · [Docker + sandboxi } ``` -### [Signal](https://docs.clawd.bot/signal) +### [Signal](https://docs.clawd.bot/providers/signal) - Requires `signal-cli` and a `signal` config section. -### [iMessage](https://docs.clawd.bot/imessage) +### [iMessage](https://docs.clawd.bot/providers/imessage) - macOS only; Messages must be signed in. - If `imessage.groups` is set, it becomes a group allowlist; include `"*"` to allow all. -### [WebChat](https://docs.clawd.bot/webchat) +### [WebChat](https://docs.clawd.bot/web/webchat) - Uses the Gateway WebSocket; no separate WebChat port/config. @@ -376,68 +376,68 @@ Browser control (optional): Use these when you’re past the onboarding flow and want the deeper reference. - [Start with the docs index for navigation and “what’s where.”](https://docs.clawd.bot) -- [Read the architecture overview for the gateway + protocol model.](https://docs.clawd.bot/architecture) -- [Use the full configuration reference when you need every key and example.](https://docs.clawd.bot/configuration) +- [Read the architecture overview for the gateway + protocol model.](https://docs.clawd.bot/concepts/architecture) +- [Use the full configuration reference when you need every key and example.](https://docs.clawd.bot/gateway/configuration) - [Run the Gateway by the book with the operational runbook.](https://docs.clawd.bot/gateway) - [Learn how the Control UI/Web surfaces work and how to expose them safely.](https://docs.clawd.bot/web) -- [Understand remote access over SSH tunnels or tailnets.](https://docs.clawd.bot/remote) -- [Follow the onboarding wizard flow for a guided setup.](https://docs.clawd.bot/wizard) -- [Wire external triggers via the webhook surface.](https://docs.clawd.bot/webhook) -- [Set up Gmail Pub/Sub triggers.](https://docs.clawd.bot/gmail-pubsub) -- [Learn the macOS menu bar companion details.](https://docs.clawd.bot/mac/menu-bar) -- [Platform guides: Windows (WSL2)](https://docs.clawd.bot/windows), [Linux](https://docs.clawd.bot/linux), [macOS](https://docs.clawd.bot/macos), [iOS](https://docs.clawd.bot/ios), [Android](https://docs.clawd.bot/android) -- [Debug common failures with the troubleshooting guide.](https://docs.clawd.bot/troubleshooting) -- [Review security guidance before exposing anything.](https://docs.clawd.bot/security) +- [Understand remote access over SSH tunnels or tailnets.](https://docs.clawd.bot/gateway/remote) +- [Follow the onboarding wizard flow for a guided setup.](https://docs.clawd.bot/start/wizard) +- [Wire external triggers via the webhook surface.](https://docs.clawd.bot/automation/webhook) +- [Set up Gmail Pub/Sub triggers.](https://docs.clawd.bot/automation/gmail-pubsub) +- [Learn the macOS menu bar companion details.](https://docs.clawd.bot/platforms/mac/menu-bar) +- [Platform guides: Windows (WSL2)](https://docs.clawd.bot/platforms/windows), [Linux](https://docs.clawd.bot/platforms/linux), [macOS](https://docs.clawd.bot/platforms/macos), [iOS](https://docs.clawd.bot/platforms/ios), [Android](https://docs.clawd.bot/platforms/android) +- [Debug common failures with the troubleshooting guide.](https://docs.clawd.bot/providers/troubleshooting) +- [Review security guidance before exposing anything.](https://docs.clawd.bot/gateway/security) ## Advanced docs (discovery + control) -- [Discovery + transports](https://docs.clawd.bot/discovery) -- [Bonjour/mDNS](https://docs.clawd.bot/bonjour) +- [Discovery + transports](https://docs.clawd.bot/gateway/discovery) +- [Bonjour/mDNS](https://docs.clawd.bot/gateway/bonjour) - [Gateway pairing](https://docs.clawd.bot/gateway/pairing) -- [Remote gateway README](https://docs.clawd.bot/remote-gateway-readme) -- [Control UI](https://docs.clawd.bot/control-ui) -- [Dashboard](https://docs.clawd.bot/dashboard) +- [Remote gateway README](https://docs.clawd.bot/gateway/remote-gateway-readme) +- [Control UI](https://docs.clawd.bot/web/control-ui) +- [Dashboard](https://docs.clawd.bot/web/dashboard) ## Operations & troubleshooting -- [Health checks](https://docs.clawd.bot/health) -- [Gateway lock](https://docs.clawd.bot/gateway-lock) -- [Background process](https://docs.clawd.bot/background-process) -- [Browser troubleshooting (Linux)](https://docs.clawd.bot/browser-linux-troubleshooting) +- [Health checks](https://docs.clawd.bot/gateway/health) +- [Gateway lock](https://docs.clawd.bot/gateway/gateway-lock) +- [Background process](https://docs.clawd.bot/gateway/background-process) +- [Browser troubleshooting (Linux)](https://docs.clawd.bot/tools/browser-linux-troubleshooting) - [Logging](https://docs.clawd.bot/logging) ## Deep dives -- [Agent loop](https://docs.clawd.bot/agent-loop) -- [Presence](https://docs.clawd.bot/presence) -- [TypeBox schemas](https://docs.clawd.bot/typebox) -- [RPC adapters](https://docs.clawd.bot/rpc) -- [Queue](https://docs.clawd.bot/queue) +- [Agent loop](https://docs.clawd.bot/concepts/agent-loop) +- [Presence](https://docs.clawd.bot/concepts/presence) +- [TypeBox schemas](https://docs.clawd.bot/concepts/typebox) +- [RPC adapters](https://docs.clawd.bot/reference/rpc) +- [Queue](https://docs.clawd.bot/concepts/queue) ## Workspace & skills -- [Skills config](https://docs.clawd.bot/skills-config) -- [Default AGENTS](https://docs.clawd.bot/AGENTS.default) -- [Templates: AGENTS](https://docs.clawd.bot/templates/AGENTS) -- [Templates: BOOTSTRAP](https://docs.clawd.bot/templates/BOOTSTRAP) -- [Templates: IDENTITY](https://docs.clawd.bot/templates/IDENTITY) -- [Templates: SOUL](https://docs.clawd.bot/templates/SOUL) -- [Templates: TOOLS](https://docs.clawd.bot/templates/TOOLS) -- [Templates: USER](https://docs.clawd.bot/templates/USER) +- [Skills config](https://docs.clawd.bot/tools/skills-config) +- [Default AGENTS](https://docs.clawd.bot/reference/AGENTS.default) +- [Templates: AGENTS](https://docs.clawd.bot/reference/templates/AGENTS) +- [Templates: BOOTSTRAP](https://docs.clawd.bot/reference/templates/BOOTSTRAP) +- [Templates: IDENTITY](https://docs.clawd.bot/reference/templates/IDENTITY) +- [Templates: SOUL](https://docs.clawd.bot/reference/templates/SOUL) +- [Templates: TOOLS](https://docs.clawd.bot/reference/templates/TOOLS) +- [Templates: USER](https://docs.clawd.bot/reference/templates/USER) ## Platform internals -- [macOS dev setup](https://docs.clawd.bot/mac/dev-setup) -- [macOS menu bar](https://docs.clawd.bot/mac/menu-bar) -- [macOS voice wake](https://docs.clawd.bot/mac/voicewake) -- [iOS node](https://docs.clawd.bot/ios) -- [Android node](https://docs.clawd.bot/android) -- [Windows (WSL2)](https://docs.clawd.bot/windows) -- [Linux app](https://docs.clawd.bot/linux) +- [macOS dev setup](https://docs.clawd.bot/platforms/mac/dev-setup) +- [macOS menu bar](https://docs.clawd.bot/platforms/mac/menu-bar) +- [macOS voice wake](https://docs.clawd.bot/platforms/mac/voicewake) +- [iOS node](https://docs.clawd.bot/platforms/ios) +- [Android node](https://docs.clawd.bot/platforms/android) +- [Windows (WSL2)](https://docs.clawd.bot/platforms/windows) +- [Linux app](https://docs.clawd.bot/platforms/linux) ## Email hooks (Gmail) -- [docs.clawd.bot/gmail-pubsub](https://docs.clawd.bot/gmail-pubsub) +- [docs.clawd.bot/gmail-pubsub](https://docs.clawd.bot/automation/gmail-pubsub) ## Clawd