diff --git a/AGENTS.md b/AGENTS.md index 021a8a9c4..763fdca75 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -28,6 +28,7 @@ - Add brief code comments for tricky or non-obvious logic. - Keep files concise; extract helpers instead of “V2” copies. Use existing patterns for CLI options and dependency injection via `createDefaultDeps`. - Aim to keep files under ~700 LOC; guideline only (not a hard guardrail). Split/refactor when it improves clarity or testability. +- Naming: use **Clawdbot** for product/app/docs headings; use `clawdbot` for CLI command, package/binary, paths, and config keys. ## Testing Guidelines - Framework: Vitest with V8 coverage thresholds (70% lines/branches/functions/statements). diff --git a/docs/_config.yml b/docs/_config.yml index b32025cad..434b27b28 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -22,7 +22,7 @@ defaults: nav: - title: "Home" url: "/" - - title: "Clawd Setup" + - title: "Clawdbot Assistant" url: "/start/clawd/" - title: "Gateway" url: "/gateway/" diff --git a/docs/automation/cron-jobs.md b/docs/automation/cron-jobs.md index 0b9fdca23..56852b65f 100644 --- a/docs/automation/cron-jobs.md +++ b/docs/automation/cron-jobs.md @@ -80,7 +80,7 @@ the topic/thread into the `to` field: - `-1001234567890:topic:123` (preferred: explicit topic marker) - `-1001234567890:123` (shorthand: numeric suffix) -Internal prefixes like `telegram:...` / `telegram:group:...` are also accepted: +Prefixed targets like `telegram:...` / `telegram:group:...` are also accepted: - `telegram:group:-1001234567890:topic:123` ## Storage & history diff --git a/docs/cli/index.md b/docs/cli/index.md index 284a126e9..b5a261368 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -1,5 +1,5 @@ --- -summary: "CLI reference for clawdbot commands, subcommands, and options" +summary: "Clawdbot CLI reference for `clawdbot` commands, subcommands, and options" read_when: - Adding or modifying CLI commands or options - Documenting new command surfaces diff --git a/docs/concepts/agent-loop.md b/docs/concepts/agent-loop.md index 61cb748c0..5a1190687 100644 --- a/docs/concepts/agent-loop.md +++ b/docs/concepts/agent-loop.md @@ -3,7 +3,7 @@ summary: "Agent loop lifecycle, streams, and wait semantics" read_when: - You need an exact walkthrough of the agent loop or lifecycle events --- -# Agent Loop (Clawdis) +# Agent Loop (Clawdbot) Short, exact flow of one agent run. @@ -23,7 +23,7 @@ Short, exact flow of one agent run. - streams assistant deltas + tool events - enforces timeout -> aborts run if exceeded - returns payloads + usage metadata -4) `subscribeEmbeddedPiSession` bridges pi-agent-core events to Clawdis `agent` stream: +4) `subscribeEmbeddedPiSession` bridges pi-agent-core events to Clawdbot `agent` stream: - tool events => `stream: "tool"` - assistant deltas => `stream: "assistant"` - lifecycle events => `stream: "lifecycle"` (`phase: "start" | "end" | "error"`) diff --git a/docs/concepts/provider-routing.md b/docs/concepts/provider-routing.md index c5f474c4b..0290eaa0c 100644 --- a/docs/concepts/provider-routing.md +++ b/docs/concepts/provider-routing.md @@ -16,7 +16,7 @@ host configuration. - **Provider**: `whatsapp`, `telegram`, `discord`, `slack`, `signal`, `imessage`, `webchat`. - **AccountId**: per‑provider account instance (when supported). - **AgentId**: an isolated workspace + session store (“brain”). -- **SessionKey**: the internal bucket key used to store context and control concurrency. +- **SessionKey**: the bucket key used to store context and control concurrency. ## Session key shapes (examples) diff --git a/docs/concepts/system-prompt.md b/docs/concepts/system-prompt.md index 2d1a236cc..14c862e3a 100644 --- a/docs/concepts/system-prompt.md +++ b/docs/concepts/system-prompt.md @@ -1,12 +1,12 @@ --- -summary: "What the ClaudeBot system prompt contains and how it is assembled" +summary: "What the Clawdbot system prompt contains and how it is assembled" read_when: - Editing system prompt text, tools list, or time/heartbeat sections - Changing workspace bootstrap or skills injection behavior --- # System Prompt -ClaudeBot builds a custom system prompt for every agent run. The prompt is **Clawdbot-owned** and does not use the p-coding-agent default prompt. +Clawdbot builds a custom system prompt for every agent run. The prompt is **Clawdbot-owned** and does not use the p-coding-agent default prompt. The prompt is assembled by Clawdbot and injected into each agent run. @@ -16,7 +16,7 @@ The prompt is intentionally compact and uses fixed sections: - **Tooling**: current tool list + short descriptions. - **Skills**: tells the model how to load skill instructions on demand. -- **ClaudeBot Self-Update**: how to run `config.apply` and `update.run`. +- **Clawdbot Self-Update**: how to run `config.apply` and `update.run`. - **Workspace**: working directory (`agent.workspace`). - **Workspace Files (injected)**: indicates bootstrap files are included below. - **Time**: UTC default + the user’s local time (already converted). diff --git a/docs/gateway/configuration-examples.md b/docs/gateway/configuration-examples.md index 2a0e110b8..ef97465b7 100644 --- a/docs/gateway/configuration-examples.md +++ b/docs/gateway/configuration-examples.md @@ -1,9 +1,9 @@ --- summary: "Schema-accurate configuration examples for common Clawdbot setups" read_when: - - Learning how to configure clawdbot + - Learning how to configure Clawdbot - Looking for configuration examples - - Setting up clawdbot for the first time + - Setting up Clawdbot for the first time --- # Configuration Examples diff --git a/docs/index.md b/docs/index.md index fef70bcaa..ee18be7de 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,11 +20,11 @@ read_when: GitHub · Releases · Docs · - Clawd setup + Clawdbot assistant setup

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). -It’s built for [Clawd](https://clawd.me), a space lobster who needed a TARDIS. +Clawdbot also powers [Clawd](https://clawd.me), the space‑lobster assistant. ## Start here @@ -169,7 +169,7 @@ Example: - [Updating / rollback](https://docs.clawd.bot/install/updating) - [Pairing (DM + nodes)](https://docs.clawd.bot/start/pairing) - [Nix mode](https://docs.clawd.bot/install/nix) - - [Clawd personal assistant setup](https://docs.clawd.bot/start/clawd) + - [Clawdbot assistant setup (Clawd)](https://docs.clawd.bot/start/clawd) - [Skills](https://docs.clawd.bot/tools/skills) - [Skills config](https://docs.clawd.bot/tools/skills-config) - [Workspace templates](https://docs.clawd.bot/reference/templates/AGENTS) diff --git a/docs/nodes/talk.md b/docs/nodes/talk.md index 6110f0e2d..a0c723397 100644 --- a/docs/nodes/talk.md +++ b/docs/nodes/talk.md @@ -40,7 +40,7 @@ Supported keys: - `seed`, `normalize`, `lang`, `output_format`, `latency_tier` - `once` -## Config (clawdbot.json) +## Config (`~/.clawdbot/clawdbot.json`) ```json5 { "talk": { diff --git a/docs/platforms/index.md b/docs/platforms/index.md index 73db4884f..37925df78 100644 --- a/docs/platforms/index.md +++ b/docs/platforms/index.md @@ -9,7 +9,8 @@ read_when: Clawdbot core is written in TypeScript, so the CLI + Gateway run anywhere Node or Bun runs. Companion apps exist for macOS (menu bar app) and mobile nodes (iOS/Android). Windows and -Linux companion apps are planned, but the core Gateway is fully supported today. +Linux companion apps are planned, but the Gateway is fully supported today. +Native companion apps for Windows are also planned; the Gateway is recommended via WSL2. ## Choose your OS diff --git a/docs/platforms/linux.md b/docs/platforms/linux.md index e83f9db4e..c3c4ebe06 100644 --- a/docs/platforms/linux.md +++ b/docs/platforms/linux.md @@ -6,9 +6,9 @@ read_when: --- # Linux App -Clawdbot core is fully supported on Linux. The core is written in TypeScript, so it runs anywhere Node or Bun runs. +The Gateway is fully supported on Linux. The core is written in TypeScript, so it runs anywhere Node or Bun runs. -We do not have a Linux companion app yet. It is planned, and we would love contributions to make it happen. +Native Linux companion apps are planned. Contributions are welcome if you want to help build one. ## Beginner quick path (VPS) diff --git a/docs/platforms/windows.md b/docs/platforms/windows.md index ce06086a4..c74253552 100644 --- a/docs/platforms/windows.md +++ b/docs/platforms/windows.md @@ -3,15 +3,16 @@ summary: "Windows (WSL2) support + companion app status" read_when: - Installing Clawdbot on Windows - Looking for Windows companion app status - - Planning platform coverage or contributions --- # Windows (WSL2) -Clawdbot core is supported on Windows **via WSL2** (Ubuntu recommended). The +Clawdbot on Windows is recommended **via WSL2** (Ubuntu recommended). The CLI + Gateway run inside Linux, which keeps the runtime consistent. Native Windows installs are untested and more problematic. -## Install +Native Windows companion apps are planned. + +## Install (WSL2) - [Getting Started](/start/getting-started) (use inside WSL) - [Install & updates](/install/updating) - Official WSL2 guide (Microsoft): https://learn.microsoft.com/windows/wsl/install @@ -48,7 +49,7 @@ Repair/migrate: clawdbot doctor ``` -## How to install this correctly +## Step-by-step WSL2 install ### 1) Install WSL2 + Ubuntu @@ -104,5 +105,5 @@ Full guide: [Getting Started](/start/getting-started) ## Windows companion app -We do not have a Windows companion app yet. It is planned, and we would love +We do not have a Windows companion app yet. Contributions are welcome if you want contributions to make it happen. diff --git a/docs/providers/discord.md b/docs/providers/discord.md index c74cec95b..142ee73bc 100644 --- a/docs/providers/discord.md +++ b/docs/providers/discord.md @@ -274,7 +274,7 @@ Reaction notifications use `guilds..reactionNotifications`: | messages | enabled | Read/send/edit/delete | | threads | enabled | Create/list/reply | | pins | enabled | Pin/unpin/list | -| search | enabled | Message search (preview spec) | +| search | enabled | Message search (preview feature) | | memberInfo | enabled | Member info | | roleInfo | enabled | Role list | | channelInfo | enabled | Channel info + list | diff --git a/docs/start/faq.md b/docs/start/faq.md index 353c47a7a..e613463a7 100644 --- a/docs/start/faq.md +++ b/docs/start/faq.md @@ -520,7 +520,7 @@ Start the Gateway with `--verbose` to get more console detail. Then inspect the ### My skill generated an image/PDF, but nothing was sent -Outbound attachments from the agent must include a `MEDIA:` line (on its own line). See [Clawd setup](/start/clawd) and [Agent send](/tools/agent-send). +Outbound attachments from the agent must include a `MEDIA:` line (on its own line). See [Clawdbot assistant setup](/start/clawd) and [Agent send](/tools/agent-send). CLI sending: diff --git a/docs/start/hubs.md b/docs/start/hubs.md index 1317ed565..46b61871f 100644 --- a/docs/start/hubs.md +++ b/docs/start/hubs.md @@ -18,7 +18,7 @@ Use these hubs to discover every page, including deep dives and reference docs t - [FAQ](https://docs.clawd.bot/start/faq) - [Configuration](https://docs.clawd.bot/gateway/configuration) - [Configuration examples](https://docs.clawd.bot/gateway/configuration-examples) -- [Clawd (personal assistant)](https://docs.clawd.bot/start/clawd) +- [Clawdbot assistant (Clawd)](https://docs.clawd.bot/start/clawd) - [Showcase](https://docs.clawd.bot/start/showcase) - [Lore](https://docs.clawd.bot/start/lore) diff --git a/docs/start/setup.md b/docs/start/setup.md index 931aefdaf..22dc9e172 100644 --- a/docs/start/setup.md +++ b/docs/start/setup.md @@ -128,5 +128,5 @@ user service (no lingering needed). See [`docs/gateway.md`](/gateway) for the sy - [`docs/gateway.md`](/gateway) (Gateway runbook; flags, supervision, ports) - [`docs/configuration.md`](/gateway/configuration) (config schema + examples) - [`docs/discord.md`](/providers/discord) and [`docs/telegram.md`](/providers/telegram) (reply tags + replyToMode settings) -- [`docs/clawd.md`](/start/clawd) (personal assistant setup) +- [`docs/clawd.md`](/start/clawd) (Clawdbot assistant setup) - [`docs/macos.md`](/platforms/macos) (macOS app behavior; gateway lifecycle + “Attach only”) diff --git a/docs/start/showcase.md b/docs/start/showcase.md index b2239171b..867db2472 100644 --- a/docs/start/showcase.md +++ b/docs/start/showcase.md @@ -1,6 +1,7 @@ --- title: "Showcase" description: "Real-world Clawdbot projects from the community" +summary: "Community-built projects and integrations powered by Clawdbot" --- # Showcase diff --git a/docs/tools/index.md b/docs/tools/index.md index 5aa543123..45ae122ee 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -1,8 +1,8 @@ --- -summary: "Agent tool surface for Clawdbot (browser, canvas, nodes, cron) replacing clawdbot-* skills" +summary: "Agent tool surface for Clawdbot (browser, canvas, nodes, cron) replacing legacy `clawdbot-*` skills" read_when: - Adding or modifying agent tools - - Retiring or changing clawdbot-* skills + - Retiring or changing `clawdbot-*` skills --- # Tools (Clawdbot) @@ -235,7 +235,7 @@ Notes: - `reactions` returns per-emoji user lists (limited to 100 per reaction). - Reaction removal semantics: see [/tools/reactions](/tools/reactions). - `discord.actions.*` gates Discord tool actions; `roles` + `moderation` default to `false`. -- `searchMessages` follows the Discord preview spec (limit max 25, channel/author filters accept arrays). +- `searchMessages` follows the Discord preview feature constraints (limit max 25, channel/author filters accept arrays). - The tool is only exposed when the current provider is Discord. ### `whatsapp` diff --git a/docs/tools/reactions.md b/docs/tools/reactions.md index ad33976e8..21fe37e0a 100644 --- a/docs/tools/reactions.md +++ b/docs/tools/reactions.md @@ -1,3 +1,8 @@ +--- +summary: "Reaction semantics shared across providers" +read_when: + - Working on reactions in any provider +--- # Reaction tooling Shared reaction semantics across providers: