Skip to content

Latest commit

 

History

History

openclaw-tutorial

README.md

title nav_order has_children
OpenClaw Deep Dive
94
true

OpenClaw: Deep Dive Tutorial

Project: OpenClaw — Your own personal AI assistant. Any OS. Any Platform.

Stars License: MIT TypeScript

What Is OpenClaw?

OpenClaw is an open-source, self-hosted personal AI assistant that connects to the messaging channels you already use — WhatsApp, Telegram, Slack, Discord, iMessage, Signal, and more. Everything runs locally, meaning your data stays on your hardware.

Feature Description
14+ Channels WhatsApp, Telegram, Slack, Discord, Signal, iMessage, Teams, and more
Persistent Memory Long-term context, preferences, and history across sessions
Task Automation Scripts, browser control, calendar, email, cron, webhooks
Voice Speak and listen on macOS, iOS, Android via ElevenLabs TTS
Live Canvas Agent-to-UI rendering with real-time content push
50+ Skills 1Password, GitHub, Notion, Obsidian, Spotify, Trello, and more
Multi-Model Claude and GPT support with failover and key rotation
Security-First Pairing mode, Docker sandboxing, TCC permission management

Current Snapshot (auto-updated)

Architecture Overview

graph TB
    subgraph Channels["Messaging Channels"]
        WA[WhatsApp]
        TG[Telegram]
        SL[Slack]
        DC[Discord]
        IM[iMessage]
        SG[Signal]
        WEB[WebChat]
    end

    subgraph Gateway["Gateway Control Plane"]
        WS[WebSocket Server<br/>ws://127.0.0.1:18789]
        ROUTER[Session Router]
        TOOLS[Tool Registry]
    end

    subgraph Runtime["Pi Agent Runtime"]
        AGENT[Agent Core]
        MEM[Memory System]
        STREAM[Block Streaming]
        MODELS[Multi-Model Provider]
    end

    subgraph Execution["Execution Layer"]
        BROWSER[Browser CDP]
        CANVAS[Live Canvas]
        SKILLS[Skills Platform]
        CRON[Cron / Webhooks]
        DEVICE[Device Node Actions]
    end

    Channels --> Gateway
    Gateway --> Runtime
    Runtime --> Execution
Loading

Tutorial Structure

Chapter Topic What You'll Learn
1. Getting Started Installation & Setup Install OpenClaw, configure API keys, pair your first channel
2. Gateway Architecture Control Plane WebSocket server, session routing, message lifecycle
3. Channel Drivers Messaging Integration WhatsApp/Telegram/Slack/Discord drivers, message routing
4. Agent Runtime Pi Agent System Agent lifecycle, tool streaming, block streaming, multi-model
5. Memory & Sessions Persistence Long-term memory, session types, context management
6. Skills & Tools Extensibility Skill platform, built-in tools, browser control, Canvas
7. Security & Networking Security Model Pairing, sandboxing, Tailscale, remote gateway topology
8. Production Deployment Operations Docker, monitoring, scaling, multi-device orchestration

Tech Stack

Component Technology
Core Runtime TypeScript, Node.js >= 22
macOS/iOS App Swift
Android App Kotlin
Build System pnpm monorepo
WhatsApp Baileys
Telegram grammY
Slack Bolt
Discord discord.js
Browser Chrome DevTools Protocol (CDP)
Networking Tailscale Serve / Funnel
Sandboxing Docker

Prerequisites

  • Node.js >= 22
  • pnpm (for development)
  • An Anthropic or OpenAI API key
  • At least one messaging platform account (WhatsApp, Telegram, etc.)
  • macOS, Linux, or Windows (via WSL2)

Ready to begin? Start with Chapter 1: Getting Started.

Built with insights from the OpenClaw repository and community documentation.

Navigation & Backlinks

Full Chapter Map

  1. Chapter 1: Getting Started with OpenClaw
  2. Chapter 2: Gateway Architecture
  3. Chapter 3: Channel Drivers
  4. Chapter 4: Agent Runtime
  5. Chapter 5: Memory & Sessions
  6. Chapter 6: Skills & Tools
  7. Chapter 7: Security & Networking
  8. Chapter 8: Production Deployment

Source References

Generated by AI Codebase Knowledge Builder