docs: sync platform docs + nav
This commit is contained in:
@@ -1,5 +1,5 @@
|
|||||||
title: "CLAWDBOT Docs"
|
title: "CLAWDBOT Docs"
|
||||||
description: "A TypeScript/Node gateway + macOS/iOS companions for WhatsApp (web) and Telegram (bot)."
|
description: "A TypeScript/Node gateway + macOS/iOS/Android companions for WhatsApp (web) and Telegram (bot)."
|
||||||
markdown: kramdown
|
markdown: kramdown
|
||||||
highlighter: rouge
|
highlighter: rouge
|
||||||
|
|
||||||
@@ -35,9 +35,11 @@ nav:
|
|||||||
- title: "WebChat"
|
- title: "WebChat"
|
||||||
url: "/webchat.html"
|
url: "/webchat.html"
|
||||||
- title: "macOS App"
|
- title: "macOS App"
|
||||||
url: "/clawdbot-mac.html"
|
url: "/macos.html"
|
||||||
- title: "iOS Node"
|
- title: "iOS App"
|
||||||
url: "/ios/connect.html"
|
url: "/ios.html"
|
||||||
|
- title: "Android App"
|
||||||
|
url: "/android.html"
|
||||||
- title: "Telegram"
|
- title: "Telegram"
|
||||||
url: "/telegram.html"
|
url: "/telegram.html"
|
||||||
- title: "Security"
|
- title: "Security"
|
||||||
|
|||||||
@@ -32,6 +32,12 @@ Last updated: 2026-01-05
|
|||||||
- Canvas + actions: `WKWebView` with A2UI action bridge; accepts actions from local-network or trusted file URLs; intercepts `clawdbot://` deep links and forwards `agent.request` to the bridge.
|
- Canvas + actions: `WKWebView` with A2UI action bridge; accepts actions from local-network or trusted file URLs; intercepts `clawdbot://` deep links and forwards `agent.request` to the bridge.
|
||||||
- Voice/talk: voice wake sends `voice.transcript` events and syncs triggers via `voicewake.get` + `voicewake.changed`; Talk Mode attaches to the bridge.
|
- Voice/talk: voice wake sends `voice.transcript` events and syncs triggers via `voicewake.get` + `voicewake.changed`; Talk Mode attaches to the bridge.
|
||||||
|
|
||||||
|
### Android node (`apps/android`)
|
||||||
|
- Discovery + pairing: `BridgeDiscovery` uses mDNS/NSD to find `_clawdbot-bridge._tcp`, with manual host/port fallback.
|
||||||
|
- Auto-connect: `NodeRuntime` restores a stored token, performs `pair-and-hello`, and reconnects to the last discovered or manual bridge.
|
||||||
|
- Bridge runtime: `BridgeSession` owns the TCP JSONL session (`hello`/`hello-ok`, ping/pong, `req/res`, `event`, `invoke`); stores `canvasHostUrl`.
|
||||||
|
- Commands: `NodeRuntime` executes `canvas.*`, `canvas.a2ui.*`, `camera.*`, and chat/session events; foreground-only for canvas/camera.
|
||||||
|
|
||||||
## Components and flows
|
## Components and flows
|
||||||
- **Gateway (daemon)**
|
- **Gateway (daemon)**
|
||||||
- Maintains WhatsApp (Baileys), Telegram (grammY), Slack (Bolt), Discord (discord.js), Signal (signal-cli), and iMessage (imsg) connections.
|
- Maintains WhatsApp (Baileys), Telegram (grammY), Slack (Bolt), Discord (discord.js), Signal (signal-cli), and iMessage (imsg) connections.
|
||||||
|
|||||||
@@ -70,8 +70,9 @@
|
|||||||
"mac/dev-setup",
|
"mac/dev-setup",
|
||||||
"mac/menu-bar",
|
"mac/menu-bar",
|
||||||
"mac/voicewake",
|
"mac/voicewake",
|
||||||
"ios/connect",
|
"macos",
|
||||||
"android/connect",
|
"ios",
|
||||||
|
"android",
|
||||||
"webchat",
|
"webchat",
|
||||||
"web"
|
"web"
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -42,7 +42,8 @@ WhatsApp / Telegram / Discord
|
|||||||
├─ CLI (clawdbot …)
|
├─ CLI (clawdbot …)
|
||||||
├─ Chat UI (SwiftUI)
|
├─ Chat UI (SwiftUI)
|
||||||
├─ macOS app (Clawdbot.app)
|
├─ macOS app (Clawdbot.app)
|
||||||
└─ iOS node via Bridge + pairing
|
├─ iOS node via Bridge + pairing
|
||||||
|
└─ Android node via Bridge + pairing
|
||||||
```
|
```
|
||||||
|
|
||||||
Most operations flow through the **Gateway** (`clawdbot gateway`), a single long-running process that owns provider connections and the WebSocket control plane.
|
Most operations flow through the **Gateway** (`clawdbot gateway`), a single long-running process that owns provider connections and the WebSocket control plane.
|
||||||
@@ -70,6 +71,7 @@ Most operations flow through the **Gateway** (`clawdbot gateway`), a single long
|
|||||||
- 🎤 **Voice notes** — Optional transcription hook
|
- 🎤 **Voice notes** — Optional transcription hook
|
||||||
- 🖥️ **WebChat + macOS app** — Local UI + menu bar companion for ops and voice wake
|
- 🖥️ **WebChat + macOS app** — Local UI + menu bar companion for ops and voice wake
|
||||||
- 📱 **iOS node** — Pairs as a node and exposes a Canvas surface
|
- 📱 **iOS node** — Pairs as a node and exposes a Canvas surface
|
||||||
|
- 📱 **Android node** — Pairs as a node and exposes Canvas + Chat + Camera
|
||||||
|
|
||||||
Note: legacy Claude/Codex/Gemini/Opencode paths have been removed; Pi is the only coding-agent path.
|
Note: legacy Claude/Codex/Gemini/Opencode paths have been removed; Pi is the only coding-agent path.
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Peekaboo’s privileged execution moved from “CLI → XPC helper” to “CLI
|
|||||||
- It lets us piggyback on **either** Peekaboo.app’s permissions **or** Clawdbot.app’s permissions (whichever is running).
|
- It lets us piggyback on **either** Peekaboo.app’s permissions **or** Clawdbot.app’s permissions (whichever is running).
|
||||||
- It avoids “two apps with two TCC bubbles” unless needed.
|
- It avoids “two apps with two TCC bubbles” unless needed.
|
||||||
|
|
||||||
Reference (Peekaboo submodule): `docs/bridge-host.md`.
|
Reference (Peekaboo submodule): `Peekaboo/docs/bridge-host.md`.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
### Processes
|
### Processes
|
||||||
|
|||||||
@@ -94,7 +94,7 @@ Notes:
|
|||||||
- In remote mode, Clawdbot will use the configured remote tunnel/endpoint.
|
- In remote mode, Clawdbot will use the configured remote tunnel/endpoint.
|
||||||
|
|
||||||
## Build & dev workflow (native)
|
## Build & dev workflow (native)
|
||||||
- `cd native && swift build` (debug) / `swift build -c release`.
|
- `cd apps/macos && swift build` (debug) / `swift build -c release`.
|
||||||
- Run app for dev: `swift run Clawdbot` (or Xcode scheme).
|
- Run app for dev: `swift run Clawdbot` (or Xcode scheme).
|
||||||
- Package app + CLI: `scripts/package-mac-app.sh` (builds bun CLI + gateway).
|
- Package app + CLI: `scripts/package-mac-app.sh` (builds bun CLI + gateway).
|
||||||
- Tests: add Swift Testing suites under `apps/macos/Tests`.
|
- Tests: add Swift Testing suites under `apps/macos/Tests`.
|
||||||
|
|||||||
Reference in New Issue
Block a user