docs: make internal links clickable

This commit is contained in:
Peter Steinberger
2026-01-06 18:59:06 +01:00
parent d79e34040f
commit 67240252f8
41 changed files with 240 additions and 240 deletions

View File

@@ -36,9 +36,9 @@ Use `pnpm` (Node 22+) from the repo root. Keep the working tree clean before tag
- [ ] Build + sign the macOS app, then zip it for distribution. - [ ] Build + sign the macOS app, then zip it for distribution.
- [ ] Generate the Sparkle appcast (HTML notes via `scripts/make_appcast.sh`) and update `appcast.xml`. - [ ] Generate the Sparkle appcast (HTML notes via `scripts/make_appcast.sh`) and update `appcast.xml`.
- [ ] Keep the app zip (and optional dSYM zip) ready to attach to the GitHub release. - [ ] Keep the app zip (and optional dSYM zip) ready to attach to the GitHub release.
- [ ] Follow `docs/mac/release.md` for the exact commands and required env vars. - [ ] Follow [`docs/mac/release.md`](https://docs.clawd.bot/mac/release) for the exact commands and required env vars.
- `APP_BUILD` must be numeric + monotonic (no `-beta`) so Sparkle compares versions correctly. - `APP_BUILD` must be numeric + monotonic (no `-beta`) so Sparkle compares versions correctly.
- If notarizing, use the `clawdbot-notary` keychain profile created from App Store Connect API env vars (see `docs/mac/release.md`). - If notarizing, use the `clawdbot-notary` keychain profile created from App Store Connect API env vars (see [`docs/mac/release.md`](https://docs.clawd.bot/mac/release)).
6) **Publish (npm)** 6) **Publish (npm)**
- [ ] Confirm git status is clean; commit and push as needed. - [ ] Confirm git status is clean; commit and push as needed.

View File

@@ -15,7 +15,7 @@ Recommended: use `clawdbot setup` to create `~/.clawdbot/clawdbot.json` if missi
If `agent.sandbox` is enabled, non-main sessions can override this with If `agent.sandbox` is enabled, non-main sessions can override this with
per-session workspaces under `agent.sandbox.workspaceRoot` (see per-session workspaces under `agent.sandbox.workspaceRoot` (see
`docs/configuration.md`). [`docs/configuration.md`](https://docs.clawd.bot/configuration)).
## Bootstrap files (injected) ## Bootstrap files (injected)
@@ -42,7 +42,7 @@ Clawdbot loads skills from three locations (workspace wins on name conflict):
- Managed/local: `~/.clawdbot/skills` - Managed/local: `~/.clawdbot/skills`
- Workspace: `<workspace>/skills` - Workspace: `<workspace>/skills`
Skills can be gated by config/env (see `skills` in `docs/configuration.md`). Skills can be gated by config/env (see `skills` in [`docs/configuration.md`](https://docs.clawd.bot/configuration)).
## p-mono integration ## p-mono integration
@@ -81,7 +81,7 @@ message is injected before the next assistant response.
When queue mode is `followup` or `collect`, inbound messages are held until the When queue mode is `followup` or `collect`, inbound messages are held until the
current turn ends, then a new agent turn starts with the queued payloads. See current turn ends, then a new agent turn starts with the queued payloads. See
`docs/queue.md` for mode + debounce/cap behavior. [`docs/queue.md`](https://docs.clawd.bot/queue) for mode + debounce/cap behavior.
Block streaming sends completed assistant blocks as soon as they finish; disable Block streaming sends completed assistant blocks as soon as they finish; disable
via `agent.blockStreamingDefault: "off"` if you only want the final response. via `agent.blockStreamingDefault: "off"` if you only want the final response.
@@ -99,4 +99,4 @@ At minimum, set:
--- ---
*Next: [Group Chats](group-messages)* 🦞 *Next: [Group Chats](https://docs.clawd.bot/group-messages)* 🦞

View File

@@ -47,7 +47,7 @@ From the gateway machine:
dns-sd -B _clawdbot-bridge._tcp local. dns-sd -B _clawdbot-bridge._tcp local.
``` ```
More debugging notes: `docs/bonjour.md`. More debugging notes: [`docs/bonjour.md`](https://docs.clawd.bot/bonjour).
#### Tailnet (Vienna ⇄ London) discovery via unicast DNS-SD #### Tailnet (Vienna ⇄ London) discovery via unicast DNS-SD
@@ -56,7 +56,7 @@ Android NSD/mDNS discovery wont cross networks. If your Android node and the
1) Set up a DNS-SD zone (example `clawdbot.internal.`) on the gateway host and publish `_clawdbot-bridge._tcp` records. 1) Set up a DNS-SD zone (example `clawdbot.internal.`) on the gateway host and publish `_clawdbot-bridge._tcp` records.
2) Configure Tailscale split DNS for `clawdbot.internal` pointing at that DNS server. 2) Configure Tailscale split DNS for `clawdbot.internal` pointing at that DNS server.
Details and example CoreDNS config: `docs/bonjour.md`. Details and example CoreDNS config: [`docs/bonjour.md`](https://docs.clawd.bot/bonjour).
### 3) Connect from Android ### 3) Connect from Android
@@ -80,7 +80,7 @@ clawdbot nodes pending
clawdbot nodes approve <requestId> clawdbot nodes approve <requestId>
``` ```
Pairing details: `docs/gateway/pairing.md`. Pairing details: [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing).
### 5) Verify the node is connected ### 5) Verify the node is connected
@@ -130,4 +130,4 @@ Camera commands (foreground only; permission-gated):
- `camera.snap` (jpg) - `camera.snap` (jpg)
- `camera.clip` (mp4) - `camera.clip` (mp4)
See `docs/camera.md` for parameters and CLI helpers. See [`docs/camera.md`](https://docs.clawd.bot/camera) for parameters and CLI helpers.

View File

@@ -46,7 +46,7 @@ Last updated: 2026-01-05
- **Clients (mac app / CLI / web admin)** - **Clients (mac app / CLI / web admin)**
- One WS connection per client. - One WS connection per client.
- Send requests (`health`, `status`, `send`, `agent`, `system-presence`, toggles) and subscribe to events (`tick`, `agent`, `presence`, `shutdown`). - Send requests (`health`, `status`, `send`, `agent`, `system-presence`, toggles) and subscribe to events (`tick`, `agent`, `presence`, `shutdown`).
- On macOS, the app can also be invoked via deep links (`clawdbot://agent?...`) which translate into the same Gateway `agent` request path (see `docs/macos.md`). - On macOS, the app can also be invoked via deep links (`clawdbot://agent?...`) which translate into the same Gateway `agent` request path (see [`docs/macos.md`](https://docs.clawd.bot/macos)).
- **Agent process (Pi)** - **Agent process (Pi)**
- Spawned by the Gateway on demand for `agent` calls; streams events back over the same WS connection. - Spawned by the Gateway on demand for `agent` calls; streams events back over the same WS connection.
- **WebChat** - **WebChat**

View File

@@ -155,5 +155,5 @@ Bonjour/DNS-SD often escapes bytes in service instance names as decimal `\\DDD`
## Related docs ## Related docs
- Discovery policy and transport selection: `docs/discovery.md` - Discovery policy and transport selection: [`docs/discovery.md`](https://docs.clawd.bot/discovery)
- Node pairing + approvals: `docs/gateway/pairing.md` - Node pairing + approvals: [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing)

View File

@@ -290,4 +290,4 @@ Notes:
## Troubleshooting ## Troubleshooting
For Linux-specific issues (especially Ubuntu with snap Chromium), see [browser-linux-troubleshooting.md](./browser-linux-troubleshooting.md). For Linux-specific issues (especially Ubuntu with snap Chromium), see [browser-linux-troubleshooting](https://docs.clawd.bot/browser-linux-troubleshooting).

View File

@@ -191,12 +191,12 @@ Logs live under `/tmp/clawdbot/` (default: `clawdbot-YYYY-MM-DD.log`).
## Next steps ## Next steps
- WebChat: [WebChat](webchat) - WebChat: [WebChat](https://docs.clawd.bot/webchat)
- Gateway ops: [Gateway runbook](gateway) - Gateway ops: [Gateway runbook](https://docs.clawd.bot/gateway)
- Cron + wakeups: [Cron + wakeups](cron) - Cron + wakeups: [Cron + wakeups](https://docs.clawd.bot/cron)
- macOS menu bar companion: [Clawdbot macOS app](macos) - macOS menu bar companion: [Clawdbot macOS app](https://docs.clawd.bot/macos)
- iOS node app: [iOS app](ios) - iOS node app: [iOS app](https://docs.clawd.bot/ios)
- Android node app: [Android app](android) - Android node app: [Android app](https://docs.clawd.bot/android)
- Windows status: [Windows app](windows) - Windows status: [Windows app](https://docs.clawd.bot/windows)
- Linux status: [Linux app](linux) - Linux status: [Linux app](https://docs.clawd.bot/linux)
- Security: [Security](security) - Security: [Security](https://docs.clawd.bot/security)

View File

@@ -1160,7 +1160,7 @@ Convenience flags (CLI):
- `clawdbot --dev …` → uses `~/.clawdbot-dev` + shifts ports from base `19001` - `clawdbot --dev …` → uses `~/.clawdbot-dev` + shifts ports from base `19001`
- `clawdbot --profile <name> …` → uses `~/.clawdbot-<name>` (port via config/env/flags) - `clawdbot --profile <name> …` → uses `~/.clawdbot-<name>` (port via config/env/flags)
See `docs/gateway.md` for the derived port mapping (gateway/bridge/browser/canvas). See [`docs/gateway.md`](https://docs.clawd.bot/gateway) for the derived port mapping (gateway/bridge/browser/canvas).
Example: Example:
```bash ```bash
@@ -1356,7 +1356,7 @@ Template placeholders are expanded in `routing.transcribeAudio.command` (and any
## Cron (Gateway scheduler) ## Cron (Gateway scheduler)
Cron is a Gateway-owned scheduler for wakeups and scheduled jobs. See [Cron + wakeups](cron) for the full RFC and CLI examples. Cron is a Gateway-owned scheduler for wakeups and scheduled jobs. See [Cron + wakeups](https://docs.clawd.bot/cron) for the full RFC and CLI examples.
```json5 ```json5
{ {
@@ -1369,4 +1369,4 @@ Cron is a Gateway-owned scheduler for wakeups and scheduled jobs. See [Cron + wa
--- ---
*Next: [Agent Runtime](agent)* 🦞 *Next: [Agent Runtime](https://docs.clawd.bot/agent)* 🦞

View File

@@ -5,7 +5,7 @@ read_when:
--- ---
# Control channel API (newline-delimited JSON) # Control channel API (newline-delimited JSON)
**Deprecated (historical):** superseded by the WebSocket Gateway protocol (`clawdbot gateway`, see `docs/architecture.md` and `docs/gateway.md`). **Deprecated (historical):** superseded by the WebSocket Gateway protocol (`clawdbot gateway`, see [`docs/architecture.md`](https://docs.clawd.bot/architecture) and [`docs/gateway.md`](https://docs.clawd.bot/gateway)).
Current builds use a WebSocket server on `ws://127.0.0.1:18789` and do **not** expose this TCP control channel. Current builds use a WebSocket server on `ws://127.0.0.1:18789` and do **not** expose this TCP control channel.
Legacy endpoint (if present in an older build): `127.0.0.1:18789` (TCP, localhost only), typically reached via SSH port forward in remote mode. Legacy endpoint (if present in an older build): `127.0.0.1:18789` (TCP, localhost only), typically reached via SSH port forward in remote mode.

View File

@@ -16,7 +16,7 @@ Last updated: 2025-12-13
Clawdbot already has: Clawdbot already has:
- A **gateway heartbeat runner** that runs the agent with `HEARTBEAT` and suppresses `HEARTBEAT_OK` (`src/infra/heartbeat-runner.ts`). - A **gateway heartbeat runner** that runs the agent with `HEARTBEAT` and suppresses `HEARTBEAT_OK` (`src/infra/heartbeat-runner.ts`).
- A lightweight, in-memory **system event queue** (`enqueueSystemEvent`) that is injected into the next **main session** turn (`drainSystemEvents` in `src/auto-reply/reply.ts`). - A lightweight, in-memory **system event queue** (`enqueueSystemEvent`) that is injected into the next **main session** turn (`drainSystemEvents` in `src/auto-reply/reply.ts`).
- A WebSocket **Gateway** daemon that is intended to be always-on (`docs/gateway.md`). - A WebSocket **Gateway** daemon that is intended to be always-on ([`docs/gateway.md`](https://docs.clawd.bot/gateway)).
This RFC adds a small “cron job system” so Clawd can schedule future work and reliably wake itself up: This RFC adds a small “cron job system” so Clawd can schedule future work and reliably wake itself up:
- **Delayed**: run on the *next* normal heartbeat tick - **Delayed**: run on the *next* normal heartbeat tick

View File

@@ -9,9 +9,9 @@ The Gateway dashboard is the browser Control UI served at `/` by default
(override with `gateway.controlUi.basePath`). (override with `gateway.controlUi.basePath`).
Key references: Key references:
- `docs/control-ui.md` for usage and UI capabilities. - [`docs/control-ui.md`](https://docs.clawd.bot/control-ui) for usage and UI capabilities.
- `docs/tailscale.md` for Serve/Funnel automation. - [`docs/tailscale.md`](https://docs.clawd.bot/tailscale) for Serve/Funnel automation.
- `docs/web.md` for bind modes and security notes. - [`docs/web.md`](https://docs.clawd.bot/web) for bind modes and security notes.
Authentication is enforced at the WebSocket handshake via `connect.params.auth` Authentication is enforced at the WebSocket handshake via `connect.params.auth`
(token or password). See `gateway.auth` in `docs/configuration.md`. (token or password). See `gateway.auth` in [`docs/configuration.md`](https://docs.clawd.bot/configuration).

View File

@@ -42,7 +42,7 @@ Target direction:
- The **gateway** advertises its bridge via Bonjour. - The **gateway** advertises its bridge via Bonjour.
- Clients browse and show a “pick a gateway” list, then store the chosen endpoint. - Clients browse and show a “pick a gateway” list, then store the chosen endpoint.
Troubleshooting and beacon details: `docs/bonjour.md`. Troubleshooting and beacon details: [`docs/bonjour.md`](https://docs.clawd.bot/bonjour).
#### Current implementation #### Current implementation
@@ -77,7 +77,7 @@ If the gateway can detect it is running under Tailscale, it publishes `tailnetDn
When there is no direct route (or direct is disabled), clients can always connect via SSH by forwarding the loopback gateway port. When there is no direct route (or direct is disabled), clients can always connect via SSH by forwarding the loopback gateway port.
See `docs/remote.md`. See [`docs/remote.md`](https://docs.clawd.bot/remote).
## Transport selection (client policy) ## Transport selection (client policy)
@@ -92,7 +92,7 @@ Recommended client behavior:
The gateway is the source of truth for node/client admission. The gateway is the source of truth for node/client admission.
- Pairing requests are created/approved/rejected in the gateway (see `docs/gateway/pairing.md`). - Pairing requests are created/approved/rejected in the gateway (see [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing)).
- The bridge enforces: - The bridge enforces:
- auth (token / keypair) - auth (token / keypair)
- scopes/ACLs (bridge is not a raw proxy to every gateway method) - scopes/ACLs (bridge is not a raw proxy to every gateway method)

View File

@@ -3,7 +3,7 @@ summary: "Frequently asked questions about Clawdbot setup, configuration, and us
--- ---
# FAQ 🦞 # FAQ 🦞
Common questions from the community. For detailed configuration, see [configuration.md](configuration). Common questions from the community. For detailed configuration, see [Configuration](https://docs.clawd.bot/configuration).
## Installation & Setup ## Installation & Setup
@@ -290,7 +290,7 @@ Per-group activation can be changed by the owner:
- `/activation mention` — respond only when mentioned (default) - `/activation mention` — respond only when mentioned (default)
- `/activation always` — respond to all messages - `/activation always` — respond to all messages
See [groups.md](groups) for details. See [Groups](https://docs.clawd.bot/groups) for details.
--- ---
@@ -327,7 +327,7 @@ cat ~/.clawdbot/clawdbot.json | grep workspace
- **Telegram** — Via Bot API (grammY). - **Telegram** — Via Bot API (grammY).
- **Discord** — Bot integration. - **Discord** — Bot integration.
- **iMessage** — Via `imsg` CLI (macOS only). - **iMessage** — Via `imsg` CLI (macOS only).
- **Signal** — Via `signal-cli` (see [signal.md](signal)). - **Signal** — Via `signal-cli` (see [Signal](https://docs.clawd.bot/signal)).
- **WebChat** — Browser-based chat UI. - **WebChat** — Browser-based chat UI.
### Discord: Bot works in channels but not DMs? ### Discord: Bot works in channels but not DMs?

View File

@@ -111,7 +111,7 @@ CLAWDBOT_CONFIG_PATH=~/.clawdbot/b.json CLAWDBOT_STATE_DIR=~/.clawdbot-b clawdbo
- `node.invoke` — invoke a command on a node (e.g. `canvas.*`, `camera.*`). - `node.invoke` — invoke a command on a node (e.g. `canvas.*`, `camera.*`).
- `node.pair.*` — pairing lifecycle (`request`, `list`, `approve`, `reject`, `verify`). - `node.pair.*` — pairing lifecycle (`request`, `list`, `approve`, `reject`, `verify`).
See also: `docs/presence.md` for how presence is produced/deduped and why `instanceId` matters. See also: [`docs/presence.md`](https://docs.clawd.bot/presence) for how presence is produced/deduped and why `instanceId` matters.
## Events ## Events
- `agent` — streamed tool/output events from the agent run (seq-tagged). - `agent` — streamed tool/output events from the agent run (seq-tagged).

View File

@@ -13,7 +13,7 @@ Goal: Gmail watch -> Pub/Sub push -> `gog gmail watch serve` -> Clawdbot webhook
- `gcloud` installed and logged in. - `gcloud` installed and logged in.
- `gog` (gogcli) installed and authorized for the Gmail account. - `gog` (gogcli) installed and authorized for the Gmail account.
- Clawdbot hooks enabled (see `docs/webhook.md`). - Clawdbot hooks enabled (see [`docs/webhook.md`](https://docs.clawd.bot/webhook)).
- `tailscale` logged in if you want a public HTTPS endpoint via Funnel. - `tailscale` logged in if you want a public HTTPS endpoint via Funnel.
Example hook config (enable Gmail preset mapping): Example hook config (enable Gmail preset mapping):
@@ -30,7 +30,7 @@ Example hook config (enable Gmail preset mapping):
``` ```
To customize payload handling, add `hooks.mappings` or a JS/TS transform module To customize payload handling, add `hooks.mappings` or a JS/TS transform module
under `hooks.transformsDir` (see `docs/webhook.md`). under `hooks.transformsDir` (see [`docs/webhook.md`](https://docs.clawd.bot/webhook)).
## Wizard (recommended) ## Wizard (recommended)

View File

@@ -127,4 +127,4 @@ The agent system prompt includes a group intro on the first turn of a new group
- Group replies always go back to the same `chat_id`. - Group replies always go back to the same `chat_id`.
## WhatsApp specifics ## WhatsApp specifics
See `docs/group-messages.md` for WhatsApp-only behavior (history injection, mention handling details). See [`docs/group-messages.md`](https://docs.clawd.bot/group-messages) for WhatsApp-only behavior (history injection, mention handling details).

View File

@@ -9,140 +9,140 @@ Use these hubs to discover every page, including deep dives and reference docs t
## Start here ## Start here
- [Index](./index.md) - [Index](https://docs.clawd.bot)
- [Onboarding](./onboarding.md) - [Onboarding](https://docs.clawd.bot/onboarding)
- [Wizard](./wizard.md) - [Wizard](https://docs.clawd.bot/wizard)
- [Setup](./setup.md) - [Setup](https://docs.clawd.bot/setup)
- [FAQ](./faq.md) - [FAQ](https://docs.clawd.bot/faq)
- [Configuration](./configuration.md) - [Configuration](https://docs.clawd.bot/configuration)
- [Clawd (personal assistant)](./clawd.md) - [Clawd (personal assistant)](https://docs.clawd.bot/clawd)
- [Lore](./lore.md) - [Lore](https://docs.clawd.bot/lore)
## Installation + distribution ## Installation + distribution
- [Docker](./docker.md) - [Docker](https://docs.clawd.bot/docker)
- [Nix](./nix.md) - [Nix](https://docs.clawd.bot/nix)
## Core concepts ## Core concepts
- [Architecture](./architecture.md) - [Architecture](https://docs.clawd.bot/architecture)
- [Agent runtime](./agent.md) - [Agent runtime](https://docs.clawd.bot/agent)
- [Agent loop](./agent-loop.md) - [Agent loop](https://docs.clawd.bot/agent-loop)
- [Sessions](./session.md) - [Sessions](https://docs.clawd.bot/session)
- [Sessions (alias)](./sessions.md) - [Sessions (alias)](https://docs.clawd.bot/sessions)
- [Session tools](./session-tool.md) - [Session tools](https://docs.clawd.bot/session-tool)
- [Queue](./queue.md) - [Queue](https://docs.clawd.bot/queue)
- [RPC adapters](./rpc.md) - [RPC adapters](https://docs.clawd.bot/rpc)
- [TypeBox schemas](./typebox.md) - [TypeBox schemas](https://docs.clawd.bot/typebox)
- [Presence](./presence.md) - [Presence](https://docs.clawd.bot/presence)
- [Discovery + transports](./discovery.md) - [Discovery + transports](https://docs.clawd.bot/discovery)
- [Bonjour](./bonjour.md) - [Bonjour](https://docs.clawd.bot/bonjour)
- [Surface routing](./surface.md) - [Surface routing](https://docs.clawd.bot/surface)
- [Groups](./groups.md) - [Groups](https://docs.clawd.bot/groups)
- [Group messages](./group-messages.md) - [Group messages](https://docs.clawd.bot/group-messages)
## Providers + ingress ## Providers + ingress
- [WhatsApp](./whatsapp.md) - [WhatsApp](https://docs.clawd.bot/whatsapp)
- [Telegram](./telegram.md) - [Telegram](https://docs.clawd.bot/telegram)
- [Telegram (grammY notes)](./grammy.md) - [Telegram (grammY notes)](https://docs.clawd.bot/grammy)
- [Slack](./slack.md) - [Slack](https://docs.clawd.bot/slack)
- [Discord](./discord.md) - [Discord](https://docs.clawd.bot/discord)
- [Signal](./signal.md) - [Signal](https://docs.clawd.bot/signal)
- [iMessage](./imessage.md) - [iMessage](https://docs.clawd.bot/imessage)
- [WebChat](./webchat.md) - [WebChat](https://docs.clawd.bot/webchat)
- [Webhooks](./webhook.md) - [Webhooks](https://docs.clawd.bot/webhook)
- [Gmail Pub/Sub](./gmail-pubsub.md) - [Gmail Pub/Sub](https://docs.clawd.bot/gmail-pubsub)
## Gateway + operations ## Gateway + operations
- [Gateway runbook](./gateway.md) - [Gateway runbook](https://docs.clawd.bot/gateway)
- [Gateway pairing](./gateway/pairing.md) - [Gateway pairing](https://docs.clawd.bot/gateway/pairing)
- [Gateway lock](./gateway-lock.md) - [Gateway lock](https://docs.clawd.bot/gateway-lock)
- [Background process](./background-process.md) - [Background process](https://docs.clawd.bot/background-process)
- [Health](./health.md) - [Health](https://docs.clawd.bot/health)
- [Heartbeat](./heartbeat.md) - [Heartbeat](https://docs.clawd.bot/heartbeat)
- [Doctor](./doctor.md) - [Doctor](https://docs.clawd.bot/doctor)
- [Logging](./logging.md) - [Logging](https://docs.clawd.bot/logging)
- [Dashboard](./dashboard.md) - [Dashboard](https://docs.clawd.bot/dashboard)
- [Control UI](./control-ui.md) - [Control UI](https://docs.clawd.bot/control-ui)
- [Control API (legacy)](./control-api.md) - [Control API (legacy)](https://docs.clawd.bot/control-api)
- [Remote access](./remote.md) - [Remote access](https://docs.clawd.bot/remote)
- [Remote gateway README](./remote-gateway-readme.md) - [Remote gateway README](https://docs.clawd.bot/remote-gateway-readme)
- [Tailscale](./tailscale.md) - [Tailscale](https://docs.clawd.bot/tailscale)
- [Security](./security.md) - [Security](https://docs.clawd.bot/security)
- [Troubleshooting](./troubleshooting.md) - [Troubleshooting](https://docs.clawd.bot/troubleshooting)
## Tools + automation ## Tools + automation
- [Tools surface](./tools.md) - [Tools surface](https://docs.clawd.bot/tools)
- [Bash tool](./bash.md) - [Bash tool](https://docs.clawd.bot/bash)
- [Elevated mode](./elevated.md) - [Elevated mode](https://docs.clawd.bot/elevated)
- [Cron + wakeups](./cron.md) - [Cron + wakeups](https://docs.clawd.bot/cron)
- [Thinking + verbose](./thinking.md) - [Thinking + verbose](https://docs.clawd.bot/thinking)
- [Models](./models.md) - [Models](https://docs.clawd.bot/models)
- [Agent send CLI](./agent-send.md) - [Agent send CLI](https://docs.clawd.bot/agent-send)
- [Terminal UI](./tui.md) - [Terminal UI](https://docs.clawd.bot/tui)
- [Browser control](./browser.md) - [Browser control](https://docs.clawd.bot/browser)
- [Browser (Linux troubleshooting)](./browser-linux-troubleshooting.md) - [Browser (Linux troubleshooting)](https://docs.clawd.bot/browser-linux-troubleshooting)
## Nodes, media, voice ## Nodes, media, voice
- [Nodes overview](./nodes.md) - [Nodes overview](https://docs.clawd.bot/nodes)
- [Camera](./camera.md) - [Camera](https://docs.clawd.bot/camera)
- [Images](./images.md) - [Images](https://docs.clawd.bot/images)
- [Audio](./audio.md) - [Audio](https://docs.clawd.bot/audio)
- [Location command](./location-command.md) - [Location command](https://docs.clawd.bot/location-command)
- [Voice wake](./voicewake.md) - [Voice wake](https://docs.clawd.bot/voicewake)
- [Talk mode](./talk.md) - [Talk mode](https://docs.clawd.bot/talk)
## Platforms ## Platforms
- [macOS app overview](./macos.md) - [macOS app overview](https://docs.clawd.bot/macos)
- [macOS dev setup](./mac/dev-setup.md) - [macOS dev setup](https://docs.clawd.bot/mac/dev-setup)
- [macOS menu bar](./mac/menu-bar.md) - [macOS menu bar](https://docs.clawd.bot/mac/menu-bar)
- [macOS voice wake](./mac/voicewake.md) - [macOS voice wake](https://docs.clawd.bot/mac/voicewake)
- [macOS voice overlay](./mac/voice-overlay.md) - [macOS voice overlay](https://docs.clawd.bot/mac/voice-overlay)
- [macOS WebChat](./mac/webchat.md) - [macOS WebChat](https://docs.clawd.bot/mac/webchat)
- [macOS Canvas](./mac/canvas.md) - [macOS Canvas](https://docs.clawd.bot/mac/canvas)
- [macOS child process](./mac/child-process.md) - [macOS child process](https://docs.clawd.bot/mac/child-process)
- [macOS health](./mac/health.md) - [macOS health](https://docs.clawd.bot/mac/health)
- [macOS icon](./mac/icon.md) - [macOS icon](https://docs.clawd.bot/mac/icon)
- [macOS logging](./mac/logging.md) - [macOS logging](https://docs.clawd.bot/mac/logging)
- [macOS permissions](./mac/permissions.md) - [macOS permissions](https://docs.clawd.bot/mac/permissions)
- [macOS remote](./mac/remote.md) - [macOS remote](https://docs.clawd.bot/mac/remote)
- [macOS signing](./mac/signing.md) - [macOS signing](https://docs.clawd.bot/mac/signing)
- [macOS release](./mac/release.md) - [macOS release](https://docs.clawd.bot/mac/release)
- [macOS bun gateway](./mac/bun.md) - [macOS bun gateway](https://docs.clawd.bot/mac/bun)
- [macOS XPC](./mac/xpc.md) - [macOS XPC](https://docs.clawd.bot/mac/xpc)
- [macOS skills](./mac/skills.md) - [macOS skills](https://docs.clawd.bot/mac/skills)
- [macOS Peekaboo plan](./mac/peekaboo.md) - [macOS Peekaboo plan](https://docs.clawd.bot/mac/peekaboo)
- [iOS node](./ios.md) - [iOS node](https://docs.clawd.bot/ios)
- [Android node](./android.md) - [Android node](https://docs.clawd.bot/android)
- [Windows app](./windows.md) - [Windows app](https://docs.clawd.bot/windows)
- [Linux app](./linux.md) - [Linux app](https://docs.clawd.bot/linux)
- [Web surfaces](./web.md) - [Web surfaces](https://docs.clawd.bot/web)
## Workspace + templates ## Workspace + templates
- [Skills](./skills.md) - [Skills](https://docs.clawd.bot/skills)
- [Skills config](./skills-config.md) - [Skills config](https://docs.clawd.bot/skills-config)
- [Default AGENTS](./AGENTS.default.md) - [Default AGENTS](https://docs.clawd.bot/AGENTS.default)
- [Templates: AGENTS](./templates/AGENTS.md) - [Templates: AGENTS](https://docs.clawd.bot/templates/AGENTS)
- [Templates: BOOTSTRAP](./templates/BOOTSTRAP.md) - [Templates: BOOTSTRAP](https://docs.clawd.bot/templates/BOOTSTRAP)
- [Templates: IDENTITY](./templates/IDENTITY.md) - [Templates: IDENTITY](https://docs.clawd.bot/templates/IDENTITY)
- [Templates: SOUL](./templates/SOUL.md) - [Templates: SOUL](https://docs.clawd.bot/templates/SOUL)
- [Templates: TOOLS](./templates/TOOLS.md) - [Templates: TOOLS](https://docs.clawd.bot/templates/TOOLS)
- [Templates: USER](./templates/USER.md) - [Templates: USER](https://docs.clawd.bot/templates/USER)
## Experiments + proposals ## Experiments + proposals
- [Onboarding config protocol](./onboarding-config-protocol.md) - [Onboarding config protocol](https://docs.clawd.bot/onboarding-config-protocol)
- [Research: memory](./research/memory.md) - [Research: memory](https://docs.clawd.bot/research/memory)
- [Proposal: model config](./proposals/model-config.md) - [Proposal: model config](https://docs.clawd.bot/proposals/model-config)
## Testing + release ## Testing + release
- [Testing](./test.md) - [Testing](https://docs.clawd.bot/test)
- [Release checklist](./RELEASING.md) - [Release checklist](https://docs.clawd.bot/RELEASING)
- [Device models](./device-models.md) - [Device models](https://docs.clawd.bot/device-models)

View File

@@ -19,8 +19,8 @@ read_when:
<p align="center"> <p align="center">
<a href="https://github.com/clawdbot/clawdbot">GitHub</a> · <a href="https://github.com/clawdbot/clawdbot">GitHub</a> ·
<a href="https://github.com/clawdbot/clawdbot/releases">Releases</a> · <a href="https://github.com/clawdbot/clawdbot/releases">Releases</a> ·
<a href="https://github.com/clawdbot/clawdbot/blob/main/docs/index.md">Docs</a> · <a href="https://docs.clawd.bot">Docs</a> ·
<a href="./clawd.md">Clawd setup</a> <a href="https://docs.clawd.bot/clawd">Clawd setup</a>
</p> </p>
CLAWDBOT bridges WhatsApp (via WhatsApp Web / Baileys), Telegram (Bot API / grammY), Discord (Bot API / discord.js), and iMessage (imsg CLI) to coding agents like [Pi](https://github.com/badlogic/pi-mono). CLAWDBOT bridges WhatsApp (via WhatsApp Web / Baileys), Telegram (Bot API / grammY), Discord (Bot API / discord.js), and iMessage (imsg CLI) to coding agents like [Pi](https://github.com/badlogic/pi-mono).
@@ -54,8 +54,8 @@ Most operations flow through the **Gateway** (`clawdbot gateway`), a single long
- **Loopback-first**: Gateway WS defaults to `ws://127.0.0.1:18789`. - **Loopback-first**: Gateway WS defaults to `ws://127.0.0.1:18789`.
- For Tailnet access, run `clawdbot gateway --bind tailnet --token ...` (token is required for non-loopback binds). - For Tailnet access, run `clawdbot gateway --bind tailnet --token ...` (token is required for non-loopback binds).
- **Bridge for nodes**: optional LAN/tailnet-facing bridge on `tcp://0.0.0.0:18790` for paired nodes (Bonjour-discoverable). - **Bridge for nodes**: optional LAN/tailnet-facing bridge on `tcp://0.0.0.0:18790` for paired nodes (Bonjour-discoverable).
- **Canvas host**: HTTP file server on `canvasHost.port` (default `18793`), serving `/__clawdbot__/canvas/` for node WebViews; see `docs/configuration.md` (`canvasHost`). - **Canvas host**: HTTP file server on `canvasHost.port` (default `18793`), serving `/__clawdbot__/canvas/` for node WebViews; see [`docs/configuration.md`](https://docs.clawd.bot/configuration) (`canvasHost`).
- **Remote use**: SSH tunnel or tailnet/VPN; see `docs/remote.md` and `docs/discovery.md`. - **Remote use**: SSH tunnel or tailnet/VPN; see [`docs/remote.md`](https://docs.clawd.bot/remote) and [`docs/discovery.md`](https://docs.clawd.bot/discovery).
## Features (high level) ## Features (high level)
@@ -128,41 +128,41 @@ Example:
## Docs ## Docs
- Start here: - Start here:
- [Docs hubs (all pages linked)](hubs) - [Docs hubs (all pages linked)](https://docs.clawd.bot/hubs)
- [FAQ](faq) ← *common questions answered* - [FAQ](https://docs.clawd.bot/faq) ← *common questions answered*
- [Configuration](configuration) - [Configuration](https://docs.clawd.bot/configuration)
- [Nix mode](nix) - [Nix mode](https://docs.clawd.bot/nix)
- [Clawd personal assistant setup](clawd) - [Clawd personal assistant setup](https://docs.clawd.bot/clawd)
- [Skills](skills) - [Skills](https://docs.clawd.bot/skills)
- [Skills config](skills-config) - [Skills config](https://docs.clawd.bot/skills-config)
- [Workspace templates](templates/AGENTS) - [Workspace templates](https://docs.clawd.bot/templates/AGENTS)
- [RPC adapters](rpc) - [RPC adapters](https://docs.clawd.bot/rpc)
- [Gateway runbook](gateway) - [Gateway runbook](https://docs.clawd.bot/gateway)
- [Nodes (iOS/Android)](nodes) - [Nodes (iOS/Android)](https://docs.clawd.bot/nodes)
- [Web surfaces (Control UI)](web) - [Web surfaces (Control UI)](https://docs.clawd.bot/web)
- [Discovery + transports](discovery) - [Discovery + transports](https://docs.clawd.bot/discovery)
- [Remote access](remote) - [Remote access](https://docs.clawd.bot/remote)
- Providers and UX: - Providers and UX:
- [WebChat](webchat) - [WebChat](https://docs.clawd.bot/webchat)
- [Control UI (browser)](control-ui) - [Control UI (browser)](https://docs.clawd.bot/control-ui)
- [Telegram](telegram) - [Telegram](https://docs.clawd.bot/telegram)
- [Discord](discord) - [Discord](https://docs.clawd.bot/discord)
- [iMessage](imessage) - [iMessage](https://docs.clawd.bot/imessage)
- [Groups](groups) - [Groups](https://docs.clawd.bot/groups)
- [WhatsApp group messages](group-messages) - [WhatsApp group messages](https://docs.clawd.bot/group-messages)
- [Media: images](images) - [Media: images](https://docs.clawd.bot/images)
- [Media: audio](audio) - [Media: audio](https://docs.clawd.bot/audio)
- Companion apps: - Companion apps:
- [macOS app](macos) - [macOS app](https://docs.clawd.bot/macos)
- [iOS app](ios) - [iOS app](https://docs.clawd.bot/ios)
- [Android app](android) - [Android app](https://docs.clawd.bot/android)
- [Windows app](windows) - [Windows app](https://docs.clawd.bot/windows)
- [Linux app](linux) - [Linux app](https://docs.clawd.bot/linux)
- Ops and safety: - Ops and safety:
- [Sessions](session) - [Sessions](https://docs.clawd.bot/session)
- [Cron + wakeups](cron) - [Cron + wakeups](https://docs.clawd.bot/cron)
- [Security](security) - [Security](https://docs.clawd.bot/security)
- [Troubleshooting](troubleshooting) - [Troubleshooting](https://docs.clawd.bot/troubleshooting)
## The name ## The name

View File

@@ -61,7 +61,7 @@ If browse works, but the iOS node cant connect, try resolving one instance:
dns-sd -L "<instance name>" _clawdbot-bridge._tcp local. dns-sd -L "<instance name>" _clawdbot-bridge._tcp local.
``` ```
More debugging notes: `docs/bonjour.md`. More debugging notes: [`docs/bonjour.md`](https://docs.clawd.bot/bonjour).
#### Tailnet (Vienna ⇄ London) discovery via unicast DNS-SD #### Tailnet (Vienna ⇄ London) discovery via unicast DNS-SD
@@ -70,7 +70,7 @@ If the iOS node and the gateway are on different networks but connected via Tail
1) Set up a DNS-SD zone (example `clawdbot.internal.`) on the gateway host and publish `_clawdbot-bridge._tcp` records. 1) Set up a DNS-SD zone (example `clawdbot.internal.`) on the gateway host and publish `_clawdbot-bridge._tcp` records.
2) Configure Tailscale split DNS for `clawdbot.internal` pointing at that DNS server. 2) Configure Tailscale split DNS for `clawdbot.internal` pointing at that DNS server.
Details and example CoreDNS config: `docs/bonjour.md`. Details and example CoreDNS config: [`docs/bonjour.md`](https://docs.clawd.bot/bonjour).
### 3) Connect from the iOS node app ### 3) Connect from the iOS node app
@@ -102,7 +102,7 @@ clawdbot nodes approve <requestId>
After approval, the iOS node receives/stores the token and reconnects authenticated. After approval, the iOS node receives/stores the token and reconnects authenticated.
Pairing details: `docs/gateway/pairing.md`. Pairing details: [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing).
### 5) Verify the node is connected ### 5) Verify the node is connected
@@ -169,7 +169,7 @@ The response includes `{ format, base64 }` image data (default `format="jpeg"`;
- **iOS in background:** all `canvas.*` commands fail fast with `NODE_BACKGROUND_UNAVAILABLE` (bring the iOS node app to foreground). - **iOS in background:** all `canvas.*` commands fail fast with `NODE_BACKGROUND_UNAVAILABLE` (bring the iOS node app to foreground).
- **Return to default scaffold:** `canvas.navigate` with `{"url":""}` or `{"url":"/"}` returns to the built-in scaffold page. - **Return to default scaffold:** `canvas.navigate` with `{"url":""}` or `{"url":"/"}` returns to the built-in scaffold page.
- **mDNS blocked:** some networks block multicast; use a different LAN or plan a tailnet-capable bridge (see `docs/discovery.md`). - **mDNS blocked:** some networks block multicast; use a different LAN or plan a tailnet-capable bridge (see [`docs/discovery.md`](https://docs.clawd.bot/discovery)).
- **Wrong node selector:** `--node` can be the node id (UUID), display name (e.g. `iOS Node`), IP, or an unambiguous prefix. If its ambiguous, the CLI will tell you. - **Wrong node selector:** `--node` can be the node id (UUID), display name (e.g. `iOS Node`), IP, or an unambiguous prefix. If its ambiguous, the CLI will tell you.
- **Stale pairing / Keychain cleared:** if the pairing token is missing (or iOS Keychain was wiped), the node must pair again; approve a new pending request. - **Stale pairing / Keychain cleared:** if the pairing token is missing (or iOS Keychain was wiped), the node must pair again; approve a new pending request.
- **App reinstall but no reconnect:** the node restores `instanceId` + last bridge preference from Keychain; if it still comes up “unpaired”, verify Keychain persistence on your device/simulator and re-pair once. - **App reinstall but no reconnect:** the node restores `instanceId` + last bridge preference from Keychain; if it still comes up “unpaired”, verify Keychain persistence on your device/simulator and re-pair once.
@@ -195,8 +195,8 @@ Non-goals (v1):
### Current repo reality (constraints we respect) ### Current repo reality (constraints we respect)
- The Gateway WebSocket server binds to `127.0.0.1:18789` (`src/gateway/server.ts`) with an optional `CLAWDBOT_GATEWAY_TOKEN`. - The Gateway WebSocket server binds to `127.0.0.1:18789` (`src/gateway/server.ts`) with an optional `CLAWDBOT_GATEWAY_TOKEN`.
- The Gateway exposes a Canvas file server (`canvasHost`) on `canvasHost.port` (default `18793`), so nodes can `canvas.navigate` to `http://<lanHost>:18793/__clawdbot__/canvas/` and auto-reload on file changes (`docs/configuration.md`). - The Gateway exposes a Canvas file server (`canvasHost`) on `canvasHost.port` (default `18793`), so nodes can `canvas.navigate` to `http://<lanHost>:18793/__clawdbot__/canvas/` and auto-reload on file changes ([`docs/configuration.md`](https://docs.clawd.bot/configuration)).
- macOS “Canvas” is controlled via the Gateway node protocol (`canvas.*`), matching iOS/Android (`docs/mac/canvas.md`). - macOS “Canvas” is controlled via the Gateway node protocol (`canvas.*`), matching iOS/Android ([`docs/mac/canvas.md`](https://docs.clawd.bot/mac/canvas)).
- Voice wake forwards via `GatewayChannel` to Gateway `agent` (mac app: `VoiceWakeForwarder` → `GatewayConnection.sendAgent`). - Voice wake forwards via `GatewayChannel` to Gateway `agent` (mac app: `VoiceWakeForwarder` → `GatewayConnection.sendAgent`).
### Recommended topology (B): Gateway-owned Bridge + loopback Gateway ### Recommended topology (B): Gateway-owned Bridge + loopback Gateway
@@ -237,7 +237,7 @@ Desired behavior:
- If the Swift UI is present: show alert with Approve/Reject/Later. - If the Swift UI is present: show alert with Approve/Reject/Later.
- If the Swift UI is not present: `clawdbot` CLI can list pending requests and approve/reject. - If the Swift UI is not present: `clawdbot` CLI can list pending requests and approve/reject.
See `docs/gateway/pairing.md` for the API/events and storage. See [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing) for the API/events and storage.
CLI (headless approvals): CLI (headless approvals):
- `clawdbot nodes pending` - `clawdbot nodes pending`
@@ -366,7 +366,7 @@ open Clawdbot.xcodeproj
## Related docs ## Related docs
- `docs/gateway.md` (gateway runbook) - [`docs/gateway.md`](https://docs.clawd.bot/gateway) (gateway runbook)
- `docs/gateway/pairing.md` (approval + storage) - [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing) (approval + storage)
- `docs/bonjour.md` (discovery debugging) - [`docs/bonjour.md`](https://docs.clawd.bot/bonjour) (discovery debugging)
- `docs/discovery.md` (LAN vs tailnet vs SSH) - [`docs/discovery.md`](https://docs.clawd.bot/discovery) (LAN vs tailnet vs SSH)

View File

@@ -10,7 +10,7 @@ read_when:
Status: draft spec · Date: 2025-12-12 Status: draft spec · Date: 2025-12-12
Note: for iOS/Android nodes that should render agent-edited HTML/CSS/JS over the network, prefer the Gateway `canvasHost` (serves `~/clawd/canvas` over LAN/tailnet with live reload). A2UI is also **hosted by the Gateway** over HTTP. This doc focuses on the macOS in-app canvas panel. See `docs/configuration.md`. Note: for iOS/Android nodes that should render agent-edited HTML/CSS/JS over the network, prefer the Gateway `canvasHost` (serves `~/clawd/canvas` over LAN/tailnet with live reload). A2UI is also **hosted by the Gateway** over HTTP. This doc focuses on the macOS in-app canvas panel. See [`docs/configuration.md`](https://docs.clawd.bot/configuration).
Clawdbot can embed an agent-controlled “visual workspace” panel (“Canvas”) inside the macOS app using `WKWebView`, served via a **custom URL scheme** (no loopback HTTP port required). Clawdbot can embed an agent-controlled “visual workspace” panel (“Canvas”) inside the macOS app using `WKWebView`, served via a **custom URL scheme** (no loopback HTTP port required).
@@ -81,7 +81,7 @@ Canvas is exposed via the Gateway **node bridge**, so the agent can:
This should be modeled after `WebChatManager`/`WebChatSwiftUIWindowController` but targeting `clawdbot-canvas://…` URLs. This should be modeled after `WebChatManager`/`WebChatSwiftUIWindowController` but targeting `clawdbot-canvas://…` URLs.
Related: Related:
- For “invoke the agent again from UI” flows, prefer the macOS deep link scheme (`clawdbot://agent?...`) so *any* UI surface (Canvas, WebChat, native views) can trigger a new agent run. See `docs/macos.md`. - For “invoke the agent again from UI” flows, prefer the macOS deep link scheme (`clawdbot://agent?...`) so *any* UI surface (Canvas, WebChat, native views) can trigger a new agent run. See [`docs/macos.md`](https://docs.clawd.bot/macos).
## Agent commands (current) ## Agent commands (current)

View File

@@ -25,4 +25,4 @@ How to see whether the WhatsApp Web/Baileys bridge is healthy from the menu bar
- Cache the last good snapshot and the last error separately to avoid flicker; show the timestamp of each. - Cache the last good snapshot and the last error separately to avoid flicker; show the timestamp of each.
## When in doubt ## When in doubt
- You can still use the CLI flow in `docs/health.md` (`clawdbot status`, `clawdbot status --deep`, `clawdbot health --json`) and tail `/tmp/clawdbot/clawdbot-*.log` for `web-heartbeat` / `web-reconnect`. - You can still use the CLI flow in [`docs/health.md`](https://docs.clawd.bot/health) (`clawdbot status`, `clawdbot status --deep`, `clawdbot health --json`) and tail `/tmp/clawdbot/clawdbot-*.log` for `web-heartbeat` / `web-reconnect`.

View File

@@ -9,7 +9,7 @@ This app is usually built from `scripts/package-mac-app.sh`, which now:
- sets a stable debug bundle identifier: `com.clawdbot.mac.debug` - sets a stable debug bundle identifier: `com.clawdbot.mac.debug`
- writes the Info.plist with that bundle id (override via `BUNDLE_ID=...`) - writes the Info.plist with that bundle id (override via `BUNDLE_ID=...`)
- calls `scripts/codesign-mac-app.sh` to sign the main binary, bundled CLI, and app bundle so macOS treats each rebuild as the same signed bundle and keeps TCC permissions (notifications, accessibility, screen recording, mic, speech). For stable permissions, use a real signing identity; ad-hoc is opt-in and fragile (see `docs/mac/permissions.md`). - calls `scripts/codesign-mac-app.sh` to sign the main binary, bundled CLI, and app bundle so macOS treats each rebuild as the same signed bundle and keeps TCC permissions (notifications, accessibility, screen recording, mic, speech). For stable permissions, use a real signing identity; ad-hoc is opt-in and fragile (see [`docs/mac/permissions.md`](https://docs.clawd.bot/mac/permissions)).
- uses `CODESIGN_TIMESTAMP=auto` by default; it enables trusted timestamps for Developer ID signatures. Set `CODESIGN_TIMESTAMP=off` to skip timestamping (offline debug builds). - uses `CODESIGN_TIMESTAMP=auto` by default; it enables trusted timestamps for Developer ID signatures. Set `CODESIGN_TIMESTAMP=off` to skip timestamping (offline debug builds).
- inject build metadata into Info.plist: `ClawdbotBuildTimestamp` (UTC) and `ClawdbotGitCommit` (short hash) so the About pane can show build, git, and debug/release channel. - inject build metadata into Info.plist: `ClawdbotBuildTimestamp` (UTC) and `ClawdbotGitCommit` (short hash) so the About pane can show build, git, and debug/release channel.
- **Packaging requires Bun**: The embedded gateway relay is compiled using `bun`. Ensure it is installed (`curl -fsSL https://bun.sh/install | bash`). - **Packaging requires Bun**: The embedded gateway relay is compiled using `bun`. Ensure it is installed (`curl -fsSL https://bun.sh/install | bash`).
@@ -26,7 +26,7 @@ SIGN_IDENTITY="-" scripts/package-mac-app.sh # explicit ad-hoc (same cave
``` ```
### Ad-hoc Signing Note ### Ad-hoc Signing Note
When signing with `SIGN_IDENTITY="-"` (ad-hoc), the script automatically disables the **Hardened Runtime** (`--options runtime`). This is necessary to prevent crashes when the app attempts to load embedded frameworks (like Sparkle) that do not share the same Team ID. Ad-hoc signatures also break TCC permission persistence; see `docs/mac/permissions.md` for recovery steps. When signing with `SIGN_IDENTITY="-"` (ad-hoc), the script automatically disables the **Hardened Runtime** (`--options runtime`). This is necessary to prevent crashes when the app attempts to load embedded frameworks (like Sparkle) that do not share the same Team ID. Ad-hoc signatures also break TCC permission persistence; see [`docs/mac/permissions.md`](https://docs.clawd.bot/mac/permissions) for recovery steps.
## Build metadata for About ## Build metadata for About

View File

@@ -21,7 +21,7 @@ read_when:
- UI automation uses a separate UNIX socket named `bridge.sock` and the PeekabooBridge JSON protocol. - UI automation uses a separate UNIX socket named `bridge.sock` and the PeekabooBridge JSON protocol.
- Host preference order (client-side): Peekaboo.app → Claude.app → Clawdbot.app → local execution. - Host preference order (client-side): Peekaboo.app → Claude.app → Clawdbot.app → local execution.
- Security: bridge hosts require TeamID `Y5PE65HELJ`; DEBUG-only same-UID escape hatch is guarded by `PEEKABOO_ALLOW_UNSIGNED_SOCKET_CLIENTS=1` (Peekaboo convention). - Security: bridge hosts require TeamID `Y5PE65HELJ`; DEBUG-only same-UID escape hatch is guarded by `PEEKABOO_ALLOW_UNSIGNED_SOCKET_CLIENTS=1` (Peekaboo convention).
- See: `docs/mac/peekaboo.md` for the Clawdbot plan and naming. - See: [`docs/mac/peekaboo.md`](https://docs.clawd.bot/mac/peekaboo) for the Clawdbot plan and naming.
### Mach/XPC (future direction) ### Mach/XPC (future direction)
- Still optional for internal app services, but **not required** for automation now that node.invoke is the surface. - Still optional for internal app services, but **not required** for automation now that node.invoke is the surface.

View File

@@ -13,7 +13,7 @@ Author: steipete · Status: draft spec · Date: 2025-12-20
- Shows native notifications for Clawdbot/clawdbot events. - Shows native notifications for Clawdbot/clawdbot events.
- Owns TCC prompts (Notifications, Accessibility, Screen Recording, Automation/AppleScript, Microphone, Speech Recognition). - Owns TCC prompts (Notifications, Accessibility, Screen Recording, Automation/AppleScript, Microphone, Speech Recognition).
- Runs (or connects to) the **Gateway** and exposes itself as a **node** so agents can reach macOSonly features. - Runs (or connects to) the **Gateway** and exposes itself as a **node** so agents can reach macOSonly features.
- Hosts **PeekabooBridge** for UI automation (consumed by `peekaboo`; see `docs/mac/peekaboo.md`). - Hosts **PeekabooBridge** for UI automation (consumed by `peekaboo`; see [`docs/mac/peekaboo.md`](https://docs.clawd.bot/mac/peekaboo)).
- Installs a single CLI (`clawdbot`) by symlinking the bundled binary. - Installs a single CLI (`clawdbot`) by symlinking the bundled binary.
## High-level design ## High-level design

View File

@@ -67,9 +67,9 @@ timeouts that exhausted profile rotation.
## Related config ## Related config
See `docs/configuration.md` for: See [`docs/configuration.md`](https://docs.clawd.bot/configuration) for:
- `auth.profiles` / `auth.order` - `auth.profiles` / `auth.order`
- `agent.model.primary` / `agent.model.fallbacks` - `agent.model.primary` / `agent.model.fallbacks`
- `agent.imageModel` routing - `agent.imageModel` routing
See `docs/models.md` for the broader model selection and fallback overview. See [`docs/models.md`](https://docs.clawd.bot/models) for the broader model selection and fallback overview.

View File

@@ -77,7 +77,7 @@ Output
- Image routing uses `agent.imageModel` **only when configured** and the primary - Image routing uses `agent.imageModel` **only when configured** and the primary
model lacks image input. model lacks image input.
- Persist last successful provider/model to session entry; auth profile success is global. - Persist last successful provider/model to session entry; auth profile success is global.
- See `docs/model-failover.md` for auth profile rotation, cooldowns, and timeout handling. - See [`docs/model-failover.md`](https://docs.clawd.bot/model-failover) for auth profile rotation, cooldowns, and timeout handling.
## Tests ## Tests
@@ -87,5 +87,5 @@ Output
## Docs ## Docs
- Update `docs/configuration.md` with `agent.models` + `agent.model` + `agent.imageModel`. - Update [`docs/configuration.md`](https://docs.clawd.bot/configuration) with `agent.models` + `agent.model` + `agent.imageModel`.
- Keep this doc current when CLI surface or scan logic changes. - Keep this doc current when CLI surface or scan logic changes.

View File

@@ -91,5 +91,5 @@ packaging and Nix builds (which do not rely on a full Xcode toolchain).
## Related ## Related
- [nix-clawdbot](https://github.com/clawdbot/nix-clawdbot) — full setup guide - [nix-clawdbot](https://github.com/clawdbot/nix-clawdbot) — full setup guide
- [Wizard](./wizard.md) — non-Nix CLI setup - [Wizard](https://docs.clawd.bot/wizard) — non-Nix CLI setup
- [Docker](./docker.md) — containerized setup - [Docker](https://docs.clawd.bot/docker) — containerized setup

View File

@@ -14,7 +14,7 @@ macOS can also run in **node mode**: the menubar app connects to the Gateways
## Pairing + status ## Pairing + status
Pairing is gateway-owned and approval-based. See `docs/gateway/pairing.md` for the full flow. Pairing is gateway-owned and approval-based. See [`docs/gateway/pairing.md`](https://docs.clawd.bot/gateway/pairing) for the full flow.
Quick CLI: Quick CLI:

View File

@@ -43,7 +43,7 @@ Recent gateway logs show repeated `cron.add` failures with invalid parameters (m
- [x] Fix UI CronStatus type to match gateway (`jobs` instead of `jobCount`). - [x] Fix UI CronStatus type to match gateway (`jobs` instead of `jobCount`).
- [x] Update cron UI channel select to include Discord/Slack/Signal/iMessage. - [x] Update cron UI channel select to include Discord/Slack/Signal/iMessage.
- [x] Update macOS CronJobEditor channel picker + enum to include Slack/Signal/iMessage. - [x] Update macOS CronJobEditor channel picker + enum to include Slack/Signal/iMessage.
- [x] Document cron compatibility normalization policy in `docs/cron.md`. - [x] Document cron compatibility normalization policy in [`docs/cron.md`](https://docs.clawd.bot/cron).
### Phase 2 — Input normalization + tooling hardening ### Phase 2 — Input normalization + tooling hardening
- [x] Add shared cron input normalization helpers (`normalizeCronJobCreate`/`normalizeCronJobPatch`). - [x] Add shared cron input normalization helpers (`normalizeCronJobCreate`/`normalizeCronJobPatch`).

View File

@@ -64,8 +64,8 @@ Follow-up hardening work ensures Telegram allowlists behave consistently across
### Phase 3: Documentation Updates ### Phase 3: Documentation Updates
**Files**: **Files**:
- `docs/groups.md` - [`docs/groups.md`](https://docs.clawd.bot/groups)
- `docs/telegram.md` - [`docs/telegram.md`](https://docs.clawd.bot/telegram)
**Changes**: **Changes**:
- Document `tg:` alias and case-insensitive prefixes for Telegram allowlists. - Document `tg:` alias and case-insensitive prefixes for Telegram allowlists.
@@ -85,8 +85,8 @@ Follow-up hardening work ensures Telegram allowlists behave consistently across
|------|-------------|-------------| |------|-------------|-------------|
| `src/telegram/bot.ts` | Fix | Trim allowlist values; strip `telegram:` / `tg:` prefixes case-insensitively | | `src/telegram/bot.ts` | Fix | Trim allowlist values; strip `telegram:` / `tg:` prefixes case-insensitively |
| `src/telegram/bot.test.ts` | Test | Add DM + group allowlist coverage for `TG:` prefix + whitespace | | `src/telegram/bot.test.ts` | Test | Add DM + group allowlist coverage for `TG:` prefix + whitespace |
| `docs/groups.md` | Docs | Mention `tg:` alias + case-insensitive prefixes | | [`docs/groups.md`](https://docs.clawd.bot/groups) | Docs | Mention `tg:` alias + case-insensitive prefixes |
| `docs/telegram.md` | Docs | Mention `tg:` alias + case-insensitive prefixes | | [`docs/telegram.md`](https://docs.clawd.bot/telegram) | Docs | Mention `tg:` alias + case-insensitive prefixes |
--- ---

View File

@@ -8,7 +8,7 @@ read_when:
This repo supports “remote over SSH” by keeping a single Gateway (the master) running on a host (e.g., your Mac Studio) and connecting clients to it. This repo supports “remote over SSH” by keeping a single Gateway (the master) running on a host (e.g., your Mac Studio) and connecting clients to it.
- For **operators (you / the macOS app)**: SSH tunneling is the universal fallback. - For **operators (you / the macOS app)**: SSH tunneling is the universal fallback.
- For **nodes (iOS/Android and future devices)**: prefer the Gateway **Bridge** when on the same LAN/tailnet (see `docs/discovery.md`). - For **nodes (iOS/Android and future devices)**: prefer the Gateway **Bridge** when on the same LAN/tailnet (see [`docs/discovery.md`](https://docs.clawd.bot/discovery)).
## The core idea ## The core idea
@@ -58,9 +58,9 @@ WebChat no longer uses a separate HTTP port. The SwiftUI chat UI connects direct
The macOS menu bar app can drive the same setup end-to-end (remote status checks, WebChat, and Voice Wake forwarding). The macOS menu bar app can drive the same setup end-to-end (remote status checks, WebChat, and Voice Wake forwarding).
Runbook: `docs/mac/remote.md`. Runbook: [`docs/mac/remote.md`](https://docs.clawd.bot/mac/remote).
## Legacy control channel ## Legacy control channel
Older builds experimented with a newline-delimited TCP control channel on the same port. Older builds experimented with a newline-delimited TCP control channel on the same port.
That API is deprecated and should not be relied on. (Historical reference: `docs/control-api.md`.) That API is deprecated and should not be relied on. (Historical reference: [`docs/control-api.md`](https://docs.clawd.bot/control-api).)

View File

@@ -14,7 +14,7 @@ Clawdbot integrates external CLIs via JSON-RPC. Two patterns are used today.
- Health probe: `/api/v1/check`. - Health probe: `/api/v1/check`.
- Clawdbot owns lifecycle when `signal.autoStart=true`. - Clawdbot owns lifecycle when `signal.autoStart=true`.
See `docs/signal.md` for setup and endpoints. See [`docs/signal.md`](https://docs.clawd.bot/signal) for setup and endpoints.
## Pattern B: stdio child process (imsg) ## Pattern B: stdio child process (imsg)
- Clawdbot spawns `imsg rpc` as a child process. - Clawdbot spawns `imsg rpc` as a child process.
@@ -27,7 +27,7 @@ Core methods used:
- `send` - `send`
- `chats.list` (probe/diagnostics) - `chats.list` (probe/diagnostics)
See `docs/imessage.md` for setup and addressing (`chat_id` preferred). See [`docs/imessage.md`](https://docs.clawd.bot/imessage) for setup and addressing (`chat_id` preferred).
## Adapter guidelines ## Adapter guidelines
- Gateway owns the process (start/stop tied to provider lifecycle). - Gateway owns the process (start/stop tied to provider lifecycle).

View File

@@ -154,7 +154,7 @@ This runs the Gateway (and its provider integrations) inside a Docker container.
If you do this right, the container becomes the “host boundary”, and you only If you do this right, the container becomes the “host boundary”, and you only
expose what you explicitly mount in. expose what you explicitly mount in.
Docs: `docs/docker.md` (Docker Compose setup + onboarding). Docs: [`docs/docker.md`](https://docs.clawd.bot/docker) (Docker Compose setup + onboarding).
Hardening reminders: Hardening reminders:
- Dont mount your entire home directory. - Dont mount your entire home directory.
@@ -182,8 +182,8 @@ Default container hardening (configurable via `agent.sandbox.docker`):
- per-session workspace mounted at `/workspace` - per-session workspace mounted at `/workspace`
Docs: Docs:
- `docs/configuration.md``agent.sandbox` - [`docs/configuration.md`](https://docs.clawd.bot/configuration)`agent.sandbox`
- `docs/docker.md` → “Per-session Agent Sandbox” - [`docs/docker.md`](https://docs.clawd.bot/docker) → “Per-session Agent Sandbox”
Important: `agent.elevated` is an explicit escape hatch that runs bash on the Important: `agent.elevated` is an explicit escape hatch that runs bash on the
host. Keep `agent.elevated.allowFrom` tight and dont enable it for strangers. host. Keep `agent.elevated.allowFrom` tight and dont enable it for strangers.

View File

@@ -5,4 +5,4 @@ read_when:
--- ---
# Sessions # Sessions
Canonical session management docs live in `docs/session.md`. Canonical session management docs live in [`docs/session.md`](https://docs.clawd.bot/session).

View File

@@ -17,7 +17,7 @@ Last updated: 2026-01-01
## Prereqs (from source) ## Prereqs (from source)
- Node `>=22` - Node `>=22`
- `pnpm` - `pnpm`
- Docker (optional; only for containerized setup/e2e — see `docs/docker.md`) - Docker (optional; only for containerized setup/e2e — see [`docs/docker.md`](https://docs.clawd.bot/docker))
## Tailoring strategy (so updates dont hurt) ## Tailoring strategy (so updates dont hurt)
@@ -120,12 +120,12 @@ sudo loginctl enable-linger $USER
``` ```
For always-on or multi-user servers, consider a **system** service instead of a For always-on or multi-user servers, consider a **system** service instead of a
user service (no lingering needed). See `docs/gateway.md` for the systemd notes. user service (no lingering needed). See [`docs/gateway.md`](https://docs.clawd.bot/gateway) for the systemd notes.
## Related docs ## Related docs
- `docs/gateway.md` (Gateway runbook; flags, supervision, ports) - [`docs/gateway.md`](https://docs.clawd.bot/gateway) (Gateway runbook; flags, supervision, ports)
- `docs/configuration.md` (config schema + examples) - [`docs/configuration.md`](https://docs.clawd.bot/configuration) (config schema + examples)
- `docs/discord.md` and `docs/telegram.md` (reply tags + replyToMode settings) - [`docs/discord.md`](https://docs.clawd.bot/discord) and [`docs/telegram.md`](https://docs.clawd.bot/telegram) (reply tags + replyToMode settings)
- `docs/clawd.md` (personal assistant setup) - [`docs/clawd.md`](https://docs.clawd.bot/clawd) (personal assistant setup)
- `docs/macos.md` (macOS app behavior; gateway lifecycle + “Attach only”) - [`docs/macos.md`](https://docs.clawd.bot/macos) (macOS app behavior; gateway lifecycle + “Attach only”)

View File

@@ -142,6 +142,6 @@ copy). Workspace skills are user-owned and override both on name conflicts.
## Config reference ## Config reference
See `docs/skills-config.md` for the full configuration schema. See [`docs/skills-config.md`](https://docs.clawd.bot/skills-config) for the full configuration schema.
--- ---

View File

@@ -35,7 +35,7 @@ read_when:
- When verbose is on, agents that emit structured tool results (Pi, other JSON agents) send each tool result back as its own metadata-only message, prefixed with `<emoji> <tool-name>: <arg>` when available (path/command); the tool output itself is not forwarded. These tool summaries are sent as soon as each tool finishes (separate bubbles), not as streaming deltas. If you toggle `/verbose on|off` while a run is in-flight, subsequent tool bubbles honor the new setting. - When verbose is on, agents that emit structured tool results (Pi, other JSON agents) send each tool result back as its own metadata-only message, prefixed with `<emoji> <tool-name>: <arg>` when available (path/command); the tool output itself is not forwarded. These tool summaries are sent as soon as each tool finishes (separate bubbles), not as streaming deltas. If you toggle `/verbose on|off` while a run is in-flight, subsequent tool bubbles honor the new setting.
## Related ## Related
- Elevated mode docs live in `docs/elevated.md`. - Elevated mode docs live in [`docs/elevated.md`](https://docs.clawd.bot/elevated).
## Heartbeats ## Heartbeats
- Heartbeat probe body is `HEARTBEAT`. Inline directives in a heartbeat message apply as usual (but avoid changing session defaults from heartbeats). - Heartbeat probe body is `HEARTBEAT`. Inline directives in a heartbeat message apply as usual (but avoid changing session defaults from heartbeats).

View File

@@ -254,4 +254,4 @@ Then set in config:
} }
``` ```
**Full guide:** See [browser-linux-troubleshooting.md](./browser-linux-troubleshooting.md) **Full guide:** See [browser-linux-troubleshooting](https://docs.clawd.bot/browser-linux-troubleshooting)

View File

@@ -26,7 +26,7 @@ The UI talks directly to the Gateway WS and supports:
## Webhooks ## Webhooks
When `hooks.enabled=true`, the Gateway also exposes a small webhook surface on the same HTTP server. When `hooks.enabled=true`, the Gateway also exposes a small webhook surface on the same HTTP server.
See `docs/configuration.md``hooks` for auth + payloads. See [`docs/configuration.md`](https://docs.clawd.bot/configuration)`hooks` for auth + payloads.
## Config (default-on) ## Config (default-on)

View File

@@ -144,7 +144,7 @@ WhatsApp requires a real mobile number for verification. VoIP and virtual number
## Logs + troubleshooting ## Logs + troubleshooting
- Subsystems: `whatsapp/inbound`, `whatsapp/outbound`, `web-heartbeat`, `web-reconnect`. - Subsystems: `whatsapp/inbound`, `whatsapp/outbound`, `web-heartbeat`, `web-reconnect`.
- Log file: `/tmp/clawdbot/clawdbot-YYYY-MM-DD.log` (configurable). - Log file: `/tmp/clawdbot/clawdbot-YYYY-MM-DD.log` (configurable).
- Troubleshooting guide: `docs/troubleshooting.md`. - Troubleshooting guide: [`docs/troubleshooting.md`](https://docs.clawd.bot/troubleshooting).
## Tests ## Tests
- `src/web/auto-reply.test.ts` (mention gating, history injection, reply flow) - `src/web/auto-reply.test.ts` (mention gating, history injection, reply flow)

View File

@@ -161,7 +161,7 @@ Sessions are stored under `~/.clawdbot/sessions/`.
## Related docs ## Related docs
- macOS app onboarding: `docs/onboarding.md` - macOS app onboarding: [`docs/onboarding.md`](https://docs.clawd.bot/onboarding)
- Config reference: `docs/configuration.md` - Config reference: [`docs/configuration.md`](https://docs.clawd.bot/configuration)
- Providers: `docs/whatsapp.md`, `docs/telegram.md`, `docs/discord.md`, `docs/signal.md`, `docs/imessage.md` - Providers: [`docs/whatsapp.md`](https://docs.clawd.bot/whatsapp), [`docs/telegram.md`](https://docs.clawd.bot/telegram), [`docs/discord.md`](https://docs.clawd.bot/discord), [`docs/signal.md`](https://docs.clawd.bot/signal), [`docs/imessage.md`](https://docs.clawd.bot/imessage)
- Skills: `docs/skills.md`, `docs/skills-config.md` - Skills: [`docs/skills.md`](https://docs.clawd.bot/skills), [`docs/skills-config.md`](https://docs.clawd.bot/skills-config)