🦞 Rebrand to CLAWDIS - add docs, update README

- New README with CLAWDIS branding - docs/index.md - Main landing page - docs/configuration.md - Config guide - docs/agents.md - Agent integration guide - docs/security.md - Security lessons (including the find ~ incident) - docs/troubleshooting.md - Debug guide - docs/lore.md - The origin story EXFOLIATE!
2025-12-03 15:45:32 +00:00
parent 7bc56d7cfe
commit a27ee2366e
7 changed files with 1031 additions and 208 deletions
--- a/docs/agents.md
+++ b/docs/agents.md
@@ -0,0 +1,234 @@
+# Agent Integration 🤖
+
+CLAWDIS can work with any AI agent that accepts prompts via CLI. Here's how to set them up.
+
+## Supported Agents
+
+### Tau / Pi
+
+The recommended agent for CLAWDIS. Built by Mario Zechner, forked with love.
+
+```json
+{
+  "reply": {
+    "mode": "command",
+    "agent": {
+      "kind": "pi",
+      "format": "json"
+    },
+    "command": [
+      "node",
+      "/path/to/pi-mono/packages/coding-agent/dist/cli.js",
+      "-p",
+      "--mode", "json",
+      "{{BodyStripped}}"
+    ]
+  }
+}
+```
+
+#### RPC Mode (Recommended)
+
+For streaming tool output and better integration:
+
+```json
+{
+  "command": [
+    "tau",
+    "--mode", "rpc",
+    "--session", "/path/to/sessions/{{SessionId}}.jsonl"
+  ]
+}
+```
+
+RPC mode gives you:
+- 💻 Real-time tool execution display
+- 📊 Token usage tracking
+- 🔄 Streaming responses
+
+### Claude Code
+
+```json
+{
+  "command": [
+    "claude",
+    "-p",
+    "{{BodyStripped}}"
+  ]
+}
+```
+
+### Custom Agents
+
+Any CLI that:
+1. Accepts a prompt as an argument
+2. Outputs text to stdout
+3. Exits when done
+
+```json
+{
+  "command": [
+    "/path/to/my-agent",
+    "--prompt", "{{Body}}",
+    "--format", "text"
+  ]
+}
+```
+
+## Session Management
+
+### Per-Sender Sessions
+
+Each phone number gets its own conversation history:
+
+```json
+{
+  "session": {
+    "scope": "per-sender",
+    "sessionArgNew": ["--session", "{{SessionId}}.jsonl"],
+    "sessionArgResume": ["--session", "{{SessionId}}.jsonl", "--continue"]
+  }
+}
+```
+
+### Global Session
+
+Everyone shares the same context (useful for team bots):
+
+```json
+{
+  "session": {
+    "scope": "global"
+  }
+}
+```
+
+### Session Reset
+
+Users can start fresh with trigger words:
+
+```json
+{
+  "session": {
+    "resetTriggers": ["/new", "/reset", "/clear"]
+  }
+}
+```
+
+## System Prompts
+
+Give your agent personality:
+
+```json
+{
+  "session": {
+    "sessionIntro": "You are Clawd, a space lobster AI assistant. Be helpful, be funny, use 🦞 liberally. Read /path/to/AGENTS.md for your instructions.",
+    "sendSystemOnce": true
+  }
+}
+```
+
+## Heartbeats
+
+Keep your agent alive and doing background tasks:
+
+```json
+{
+  "reply": {
+    "heartbeatMinutes": 10,
+    "heartbeatBody": "HEARTBEAT"
+  }
+}
+```
+
+The agent receives "HEARTBEAT" and can:
+- Check for pending tasks
+- Update memory files
+- Monitor systems
+- Reply with `HEARTBEAT_OK` to skip
+
+## Tool Streaming
+
+When using RPC mode, CLAWDIS shows tool usage in real-time:
+
+```
+💻 ls -la ~/Projects
+📄 Reading README.md
+✍️ Writing config.json
+📝 Editing main.ts
+📎 Attaching image.jpg
+🛠️ Running custom tool
+```
+
+Configure the display:
+
+```json
+{
+  "agent": {
+    "kind": "pi",
+    "format": "json",
+    "toolEmoji": {
+      "bash": "💻",
+      "read": "📄",
+      "write": "✍️",
+      "edit": "📝",
+      "attach": "📎"
+    }
+  }
+}
+```
+
+## Timeouts
+
+Long-running tasks need appropriate timeouts:
+
+```json
+{
+  "reply": {
+    "timeoutSeconds": 1800
+  }
+}
+```
+
+For background tasks, the agent can yield and continue later using the `process` tool.
+
+## Error Handling
+
+When the agent fails:
+
+1. CLAWDIS logs the error
+2. Sends a user-friendly message
+3. Preserves the session for retry
+
+```json
+{
+  "reply": {
+    "errorMessage": "🦞 Oops! Something went wrong. Try again?"
+  }
+}
+```
+
+## Multi-Agent Setup
+
+Run different agents for different numbers:
+
+```json
+{
+  "inbound": {
+    "routes": [
+      {
+        "from": "+1234567890",
+        "command": ["work-agent", "{{Body}}"]
+      },
+      {
+        "from": "+0987654321", 
+        "command": ["fun-agent", "{{Body}}"]
+      }
+    ]
+  }
+}
+```
+
+---
+
+*Next: [Group Chats](./groups.md)* 🦞