Files
clawdbot/docs/index.md
2025-12-13 13:26:44 +00:00

4.0 KiB
Raw Blame History

summary, read_when
summary read_when
Top-level overview of Clawdis, features, and purpose
Introducing Clawdis to newcomers

CLAWDIS 🦞

"EXFOLIATE! EXFOLIATE!" — A space lobster, probably

CLAWDIS

WhatsApp + Telegram gateway for AI agents (Pi).
Send a message, get an agent response — from your pocket.

GitHub · npm · Clawd setup

CLAWDIS bridges WhatsApp (via WhatsApp Web / Baileys) and Telegram (Bot API / grammY) to coding agents like Pi. Its built for Clawd, a space lobster who needed a TARDIS.

How it works

┌─────────────┐      ┌──────────┐      ┌─────────────┐
│  WhatsApp   │ ───▶ │ CLAWDIS  │ ───▶ │  AI Agent   │
│  Telegram   │ ───▶ │  🦞⏱️💙   │ ◀─── │    (Pi)     │
│  (You)      │ ◀─── │          │      │             │
└─────────────┘      └──────────┘      └─────────────┘

Most operations flow through the Gateway (clawdis gateway), a single long-running process that owns provider connections and the WebSocket control plane.

Features (high level)

  • 📱 WhatsApp Integration — Uses Baileys for WhatsApp Web protocol
  • ✈️ Telegram Bot — DMs + groups via grammY
  • 🤖 Agent bridge — Pi (RPC mode) with tool streaming
  • 💬 Sessions — Per-sender (or shared main) conversation context
  • 👥 Group Chat Support — Mention-based triggering in group chats
  • 📎 Media Support — Send and receive images, audio, documents
  • 🎤 Voice notes — Optional transcription hook
  • 🖥️ WebChat + macOS app — A local UI + menu bar companion for ops and voice wake

Note: legacy Claude/Codex/Gemini/Opencode paths have been removed; Pi is the only coding-agent path.

Quick start

Runtime requirement: Node ≥ 22.

# Install
npm install -g clawdis

# Pair WhatsApp Web (shows QR)
clawdis login

# Run the Gateway (leave running)
clawdis gateway --port 18789

# Open the local WebChat UI
clawdis webchat

Send a test message (requires a running Gateway):

clawdis send --to +15555550123 --message "Hello from CLAWDIS"

Configuration (optional)

Config lives at ~/.clawdis/clawdis.json.

  • If you do nothing, CLAWDIS uses the bundled Pi binary in RPC mode with per-sender sessions.
  • If you want to lock it down, start with inbound.allowFrom and (for groups) mention rules.

Example:

{
  inbound: {
    allowFrom: ["+15555550123"],
    groupChat: { requireMention: true, mentionPatterns: ["@clawd"] }
  }
}

Docs

The name

CLAWDIS = CLAW + TARDIS — because every space lobster needs a time-and-space machine.


"We're all just playing with our own prompts." — an AI, probably high on tokens

Credits

  • Peter Steinberger (@steipete) — Creator, lobster whisperer
  • Mario Zechner (@badlogicc) — Pi creator, security pen-tester
  • Clawd — The space lobster who demanded a better name

License

MIT — Free as a lobster in the ocean 🦞


"We're all just playing with our own prompts." — An AI, probably high on tokens