forked from Selig/openclaw-skill
Selig
4c966a3ad2
6 custom skills (assign-task, dispatch-webhook, daily-briefing, task-capture, qmd-brain, tts-voice) with technical documentation. Compatible with Claude Code, OpenClaw, Codex CLI, and OpenCode.
79 lines
2.4 KiB
Markdown
79 lines
2.4 KiB
Markdown
# OpenClaw
|
|
|
|
> *"EXFOLIATE! EXFOLIATE!"* — A space lobster, probably
|
|
|
|
**Any OS gateway for AI agents across WhatsApp, Telegram, Discord, iMessage, and more.**
|
|
Send a message, get an agent response from your pocket. Plugins add Mattermost and more.
|
|
|
|
### Quick Navigation Cards
|
|
- **Get Started** - Install OpenClaw and bring up the Gateway in minutes
|
|
- **Run the Wizard** - Guided setup with `openclaw onboard` and pairing flows
|
|
- **Open the Control UI** - Launch the browser dashboard for chat, config, and sessions
|
|
|
|
## Overview
|
|
|
|
OpenClaw connects chat apps to coding agents like Pi through a single Gateway process. It powers the OpenClaw assistant and supports local or remote setups.
|
|
|
|
## Architecture
|
|
|
|
```
|
|
Chat apps + plugins → Gateway → Pi agent, CLI, Web Control UI, macOS app, iOS and Android nodes
|
|
```
|
|
|
|
The Gateway serves as the single source of truth for sessions, routing, and channel connections.
|
|
|
|
## Core Capabilities
|
|
|
|
- **Multi-channel gateway** - WhatsApp, Telegram, Discord, and iMessage with one Gateway
|
|
- **Plugin channels** - Extend with Mattermost and additional packages
|
|
- **Multi-agent routing** - Isolated sessions per agent, workspace, or sender
|
|
- **Media support** - Send and receive images, audio, and documents
|
|
- **Web Control UI** - Browser dashboard for chat, config, sessions, and nodes
|
|
- **Mobile nodes** - Pair iOS and Android devices with Canvas support
|
|
|
|
## Installation Steps
|
|
|
|
```bash
|
|
npm install -g openclaw@latest
|
|
openclaw onboard --install-daemon
|
|
openclaw channels login
|
|
openclaw gateway --port 18789
|
|
```
|
|
|
|
## Dashboard Access
|
|
|
|
- **Local**: http://127.0.0.1:18789/
|
|
- **Remote**: Via web surfaces and Tailscale
|
|
|
|
## Configuration
|
|
|
|
Config location: `~/.openclaw/openclaw.json`
|
|
|
|
Default behavior: Uses bundled Pi binary in RPC mode with per-sender sessions.
|
|
|
|
Example security configuration:
|
|
```json5
|
|
{
|
|
channels: {
|
|
whatsapp: {
|
|
allowFrom: ["+15555550123"],
|
|
groups: { "*": { requireMention: true } },
|
|
},
|
|
},
|
|
messages: { groupChat: { mentionPatterns: ["@openclaw"] } },
|
|
}
|
|
```
|
|
|
|
## Documentation Sections
|
|
|
|
- Docs hubs - All guides organized by use case
|
|
- Configuration - Core Gateway settings and provider config
|
|
- Remote access - SSH and tailnet access patterns
|
|
- Channels - WhatsApp, Telegram, Discord setup
|
|
- Nodes - iOS and Android pairing
|
|
- Help - Troubleshooting resources
|
|
- Features - Complete capability list
|
|
- Multi-agent routing - Workspace isolation details
|
|
- Security - Tokens, allowlists, and controls
|
|
- Troubleshooting - Gateway diagnostics
|