Documentation Index
Comprehensive navigation hub for Clawdbot documentation - find guides, references, and tutorials.
Getting Started
| Guide | Description |
|---|---|
| Setup Guide | Installation and initial configuration |
| Onboarding Wizard | CLI-guided setup process |
| Onboarding (macOS) | macOS app first-run experience |
| Building an Assistant | Create your personal AI assistant |
| Dashboard | Local web interface |
Installation
| Topic | Description |
|---|---|
| Quick Install | curl -fsSL https://clawd.bot/install.sh | bash |
| npm Install | npm i -g clawdbot |
| Docker | Containerized deployment |
| Updating | Keep Clawdbot up to date |
Core Concepts
Architecture
| Component | Description |
|---|---|
| Gateway | Central hub for all connections |
| Agent | AI runtime and workspace |
| Channels | Messaging platform integrations |
| Skills | Extensible capabilities |
Agent System
| Topic | Description |
|---|---|
| Workspace | ~/.clawdbot/workspace configuration |
| Memory | Session and long-term memory |
| Agent Loop | How the agent processes requests |
| Sessions | Conversation management |
| Multi-Agent | Running multiple agents |
Communication Channels
| Channel | Description |
|---|---|
| WhatsApp Web integration | |
| Telegram | Telegram Bot API |
| Discord | Discord bot setup |
| Slack | Slack app integration |
| Signal | Signal messenger |
| iMessage | Apple Messages |
| Mattermost | Self-hosted chat |
| WebChat | Browser-based interface |
Gateway Operations
| Topic | Description |
|---|---|
| Pairing | Access control and approval |
| Health Monitoring | clawdbot health |
| Heartbeats | Proactive task scheduling |
| Logging | /tmp/clawdbot/ logs |
| Security | Best practices |
| Remote Access | Tailscale integration |
Tools & Automation
| Feature | Description |
|---|---|
| CLI Tools | Command-line interface |
| Cron Jobs | Scheduled tasks |
| Browser Control | Web automation |
| Sub-Agents | Delegated tasks |
| Terminal UI | Interactive interface |
Media & Nodes
| Feature | Description |
|---|---|
| Camera | Image capture |
| Images | Image processing |
| Audio | Voice and sound |
| Location | GPS and mapping |
| Voice Wake | Wake word detection |
Platform Support
| Platform | Status |
|---|---|
| macOS | Full support with native app |
| Linux | Full support via CLI |
| Windows (WSL2) | Full support via WSL2 |
| iOS | Companion app |
| Android | Companion app |
Workspace Configuration
Instruction Files
| File | Purpose |
|---|---|
AGENTS.md | Agent behavior configuration |
BOOTSTRAP.md | Initial setup instructions |
HEARTBEAT.md | Proactive task definitions |
IDENTITY.md | Agent identity |
SOUL.md | Personality settings |
TOOLS.md | Available capabilities |
USER.md | User information |
Skills & Extensions
| Topic | Description |
|---|---|
| Skills | Community plugins |
| ClawHub | Skill marketplace |
| Custom Skills | Build your own |
Additional Resources
- Showcase - Community projects
- History - Project background
- FAQ - Common questions
- Troubleshooting - Problem solving