let5see/clawdbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: naming sweep and platform wording

Browse Source
This commit is contained in:
Peter Steinberger
2026-01-08 23:25:45 +01:00
parent ed80860c34
commit 3965c5b4d2
20 changed files with 39 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
AGENTS.md
View File

@@ -28,6 +28,7 @@
- Add brief code comments for tricky or non-obvious logic. - 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`. - 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. - 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 ## Testing Guidelines
- Framework: Vitest with V8 coverage thresholds (70% lines/branches/functions/statements). - Framework: Vitest with V8 coverage thresholds (70% lines/branches/functions/statements).

2
docs/_config.yml
View File

@@ -22,7 +22,7 @@ defaults:
nav: nav:
- title: "Home" - title: "Home"
url: "/" url: "/"
- title: "Clawd Setup" - title: "Clawdbot Assistant"
url: "/start/clawd/" url: "/start/clawd/"
- title: "Gateway" - title: "Gateway"
url: "/gateway/" url: "/gateway/"

2
docs/automation/cron-jobs.md
View File

@@ -80,7 +80,7 @@ the topic/thread into the `to` field:
- `-1001234567890:topic:123` (preferred: explicit topic marker) - `-1001234567890:topic:123` (preferred: explicit topic marker)
- `-1001234567890:123` (shorthand: numeric suffix) - `-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` - `telegram:group:-1001234567890:topic:123`
## Storage & history ## Storage & history

2
docs/cli/index.md
View File

@@ -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: read_when:
- Adding or modifying CLI commands or options - Adding or modifying CLI commands or options
- Documenting new command surfaces - Documenting new command surfaces

4
docs/concepts/agent-loop.md
View File

@@ -3,7 +3,7 @@ summary: "Agent loop lifecycle, streams, and wait semantics"
read_when: read_when:
- You need an exact walkthrough of the agent loop or lifecycle events - 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. Short, exact flow of one agent run.
@@ -23,7 +23,7 @@ Short, exact flow of one agent run.
- streams assistant deltas + tool events - streams assistant deltas + tool events
- enforces timeout -> aborts run if exceeded - enforces timeout -> aborts run if exceeded
- returns payloads + usage metadata - 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"` - tool events => `stream: "tool"`
- assistant deltas => `stream: "assistant"` - assistant deltas => `stream: "assistant"`
- lifecycle events => `stream: "lifecycle"` (`phase: "start" | "end" | "error"`) - lifecycle events => `stream: "lifecycle"` (`phase: "start" | "end" | "error"`)

2
docs/concepts/provider-routing.md
View File

@@ -16,7 +16,7 @@ host configuration.
- **Provider**: `whatsapp`, `telegram`, `discord`, `slack`, `signal`, `imessage`, `webchat`. - **Provider**: `whatsapp`, `telegram`, `discord`, `slack`, `signal`, `imessage`, `webchat`.
- **AccountId**: per‑provider account instance (when supported). - **AccountId**: per‑provider account instance (when supported).
- **AgentId**: an isolated workspace + session store (“brain”). - **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) ## Session key shapes (examples)

6
docs/concepts/system-prompt.md
View File

@@ -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: read_when:
- Editing system prompt text, tools list, or time/heartbeat sections - Editing system prompt text, tools list, or time/heartbeat sections
- Changing workspace bootstrap or skills injection behavior - Changing workspace bootstrap or skills injection behavior
--- ---
# System Prompt # 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. 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. - **Tooling**: current tool list + short descriptions.
- **Skills**: tells the model how to load skill instructions on demand. - **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**: working directory (`agent.workspace`).
- **Workspace Files (injected)**: indicates bootstrap files are included below. - **Workspace Files (injected)**: indicates bootstrap files are included below.
- **Time**: UTC default + the user’s local time (already converted). - **Time**: UTC default + the user’s local time (already converted).

4
docs/gateway/configuration-examples.md
View File

@@ -1,9 +1,9 @@
--- ---
summary: "Schema-accurate configuration examples for common Clawdbot setups" summary: "Schema-accurate configuration examples for common Clawdbot setups"
read_when: read_when:
- Learning how to configure clawdbot - Learning how to configure Clawdbot
- Looking for configuration examples - Looking for configuration examples
- Setting up clawdbot for the first time - Setting up Clawdbot for the first time
--- ---
# Configuration Examples # Configuration Examples

6
docs/index.md
View File

@@ -20,11 +20,11 @@ read_when:
<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://docs.clawd.bot">Docs</a> · <a href="https://docs.clawd.bot">Docs</a> ·
<a href="https://docs.clawd.bot/start/clawd">Clawd setup</a> <a href="https://docs.clawd.bot/start/clawd">Clawdbot assistant 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).
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 ## Start here
@@ -169,7 +169,7 @@ Example:
- [Updating / rollback](https://docs.clawd.bot/install/updating) - [Updating / rollback](https://docs.clawd.bot/install/updating)
- [Pairing (DM + nodes)](https://docs.clawd.bot/start/pairing) - [Pairing (DM + nodes)](https://docs.clawd.bot/start/pairing)
- [Nix mode](https://docs.clawd.bot/install/nix) - [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](https://docs.clawd.bot/tools/skills)
- [Skills config](https://docs.clawd.bot/tools/skills-config) - [Skills config](https://docs.clawd.bot/tools/skills-config)
- [Workspace templates](https://docs.clawd.bot/reference/templates/AGENTS) - [Workspace templates](https://docs.clawd.bot/reference/templates/AGENTS)

2
docs/nodes/talk.md
View File

@@ -40,7 +40,7 @@ Supported keys:
- `seed`, `normalize`, `lang`, `output_format`, `latency_tier` - `seed`, `normalize`, `lang`, `output_format`, `latency_tier`
- `once` - `once`
## Config (clawdbot.json) ## Config (`~/.clawdbot/clawdbot.json`)
```json5 ```json5
{ {
"talk": { "talk": {

3
docs/platforms/index.md
View File

@@ -9,7 +9,8 @@ read_when:
Clawdbot core is written in TypeScript, so the CLI + Gateway run anywhere Node or Bun runs. 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 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 ## Choose your OS

4
docs/platforms/linux.md
View File

@@ -6,9 +6,9 @@ read_when:
--- ---
# Linux App # 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) ## Beginner quick path (VPS)

11
docs/platforms/windows.md
View File

@@ -3,15 +3,16 @@ summary: "Windows (WSL2) support + companion app status"
read_when: read_when:
- Installing Clawdbot on Windows - Installing Clawdbot on Windows
- Looking for Windows companion app status - Looking for Windows companion app status
- Planning platform coverage or contributions
--- ---
# Windows (WSL2) # 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 CLI + Gateway run inside Linux, which keeps the runtime consistent. Native
Windows installs are untested and more problematic. Windows installs are untested and more problematic.
## Install Native Windows companion apps are planned.
## Install (WSL2)
- [Getting Started](/start/getting-started) (use inside WSL) - [Getting Started](/start/getting-started) (use inside WSL)
- [Install & updates](/install/updating) - [Install & updates](/install/updating)
- Official WSL2 guide (Microsoft): https://learn.microsoft.com/windows/wsl/install - Official WSL2 guide (Microsoft): https://learn.microsoft.com/windows/wsl/install
@@ -48,7 +49,7 @@ Repair/migrate:
clawdbot doctor clawdbot doctor
``` ```
## How to install this correctly ## Step-by-step WSL2 install
### 1) Install WSL2 + Ubuntu ### 1) Install WSL2 + Ubuntu
@@ -104,5 +105,5 @@ Full guide: [Getting Started](/start/getting-started)
## Windows companion app ## 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. contributions to make it happen.

2
docs/providers/discord.md
View File

@@ -274,7 +274,7 @@ Reaction notifications use `guilds.<id>.reactionNotifications`:
| messages | enabled | Read/send/edit/delete | | messages | enabled | Read/send/edit/delete |
| threads | enabled | Create/list/reply | | threads | enabled | Create/list/reply |
| pins | enabled | Pin/unpin/list | | pins | enabled | Pin/unpin/list |
| search | enabled | Message search (preview spec) | | search | enabled | Message search (preview feature) |
| memberInfo | enabled | Member info | | memberInfo | enabled | Member info |
| roleInfo | enabled | Role list | | roleInfo | enabled | Role list |
| channelInfo | enabled | Channel info + list | | channelInfo | enabled | Channel info + list |

2
docs/start/faq.md
View File

@@ -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 ### My skill generated an image/PDF, but nothing was sent
Outbound attachments from the agent must include a `MEDIA:<path-or-url>` 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:<path-or-url>` line (on its own line). See [Clawdbot assistant setup](/start/clawd) and [Agent send](/tools/agent-send).
CLI sending: CLI sending:

2
docs/start/hubs.md
View File

@@ -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) - [FAQ](https://docs.clawd.bot/start/faq)
- [Configuration](https://docs.clawd.bot/gateway/configuration) - [Configuration](https://docs.clawd.bot/gateway/configuration)
- [Configuration examples](https://docs.clawd.bot/gateway/configuration-examples) - [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) - [Showcase](https://docs.clawd.bot/start/showcase)
- [Lore](https://docs.clawd.bot/start/lore) - [Lore](https://docs.clawd.bot/start/lore)

2
docs/start/setup.md
View File

@@ -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/gateway.md`](/gateway) (Gateway runbook; flags, supervision, ports)
- [`docs/configuration.md`](/gateway/configuration) (config schema + examples) - [`docs/configuration.md`](/gateway/configuration) (config schema + examples)
- [`docs/discord.md`](/providers/discord) and [`docs/telegram.md`](/providers/telegram) (reply tags + replyToMode settings) - [`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”) - [`docs/macos.md`](/platforms/macos) (macOS app behavior; gateway lifecycle + “Attach only”)

1
docs/start/showcase.md
View File

@@ -1,6 +1,7 @@
--- ---
title: "Showcase" title: "Showcase"
description: "Real-world Clawdbot projects from the community" description: "Real-world Clawdbot projects from the community"
summary: "Community-built projects and integrations powered by Clawdbot"
--- ---
# Showcase # Showcase

6
docs/tools/index.md
View File

@@ -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: read_when:
- Adding or modifying agent tools - Adding or modifying agent tools
- Retiring or changing clawdbot-* skills - Retiring or changing `clawdbot-*` skills
--- ---
# Tools (Clawdbot) # Tools (Clawdbot)
@@ -235,7 +235,7 @@ Notes:
- `reactions` returns per-emoji user lists (limited to 100 per reaction). - `reactions` returns per-emoji user lists (limited to 100 per reaction).
- Reaction removal semantics: see [/tools/reactions](/tools/reactions). - Reaction removal semantics: see [/tools/reactions](/tools/reactions).
- `discord.actions.*` gates Discord tool actions; `roles` + `moderation` default to `false`. - `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. - The tool is only exposed when the current provider is Discord.
### `whatsapp` ### `whatsapp`

5
docs/tools/reactions.md
View File

@@ -1,3 +1,8 @@
---
summary: "Reaction semantics shared across providers"
read_when:
- Working on reactions in any provider
---
# Reaction tooling # Reaction tooling
Shared reaction semantics across providers: Shared reaction semantics across providers: