From 949ea38ef5ea7d745952d5900ccfb07befa853d9 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 5 Jan 2026 22:17:14 +0100 Subject: [PATCH] docs: clarify bun + browser enablement --- docs/faq.md | 6 +++--- docs/tools.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index a6128ac37..163a5f51d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -42,10 +42,10 @@ Some features are platform-specific: - **CPU:** 1 core is fine for personal use - **Disk:** ~500MB for Clawdbot + deps, plus space for logs/media -The gateway is just shuffling messages around. A Raspberry Pi 4 can run it. You can also use **Bun** instead of Node for even lower memory footprint: +The gateway is just shuffling messages around. A Raspberry Pi 4 can run it. For the CLI, prefer the Node runtime (most stable): ```bash -bun clawdbot gateway +pnpm clawdbot gateway ``` ### How do I install on Linux without Homebrew? @@ -229,7 +229,7 @@ Yes! The terminal QR code login works fine over SSH. For long-running operation: ### bun binary vs Node runtime? Clawdbot can run as: -- **bun binary** — Single executable, easy distribution, auto-restarts via launchd +- **bun binary (macOS app)** — Single executable, easy distribution, auto-restarts via launchd - **Node runtime** (`pnpm clawdbot gateway`) — More stable for WhatsApp If you see WebSocket errors like `ws.WebSocket 'upgrade' event is not implemented`, use Node instead of the bun binary. Bun's WebSocket implementation has edge cases that can break WhatsApp (Baileys). diff --git a/docs/tools.md b/docs/tools.md index 9cbbdc218..d9d87649d 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -73,7 +73,7 @@ Common parameters: - `controlUrl` (defaults from config) - `profile` (optional; defaults to `browser.defaultProfile`) Notes: -- Requires `browser.enabled=true` in `~/.clawdbot/clawdbot.json`. +- Requires `browser.enabled=true` (default is `true`; set `false` to disable). - Uses `browser.controlUrl` unless `controlUrl` is passed explicitly. - All actions accept optional `profile` parameter for multi-instance support. - When `profile` is omitted, uses `browser.defaultProfile` (defaults to "clawd").