openclaw / README.md
Simford.Dong
Replace custom wrapper with full OpenClaw project
89d226e
---
title: OpenClaw AI Assistant
emoji: 🦞
colorFrom: pink
colorTo: yellow
sdk: docker
pinned: false
license: mit
short_description: Your own personal AI assistant
---
# OpenClaw AI Assistant
> Your own personal AI assistant. Any OS. Any Platform. The lobster way. 🦞
This Hugging Face Space runs the full **OpenClaw** gateway with Control UI and WebChat support.
## Features
- πŸŽ›οΈ **Control UI** - Web-based dashboard for managing your assistant
- πŸ’¬ **WebChat** - Browser-based chat interface
- πŸ“‘ **WebSocket Gateway** - Real-time communication
- πŸ”Œ **Multi-Channel Support** - WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, and more
- πŸ€– **Multi-Model Support** - Anthropic, OpenAI, Gemini, DeepSeek, OpenRouter, etc.
- πŸ› οΈ **Tool Support** - Browser automation, Canvas, Nodes, Cron, and more
## Quick Start
### 1. Access the Control UI
Visit the Space URL to access the Control UI:
```
https://sim4imgbed-openclaw.hf.space/
```
### 2. Configure API Keys
Set environment variables in the Space settings:
**For Anthropic Claude:**
```
ANTHROPIC_AUTH_TOKEN=your-sk-ant-key
# or OAuth: ANTHROPIC_AUTH_REFRESH_TOKEN=your-refresh-token
```
**For OpenAI:**
```
OPENAI_KEY=your-sk-key
```
**For Gemini:**
```
GEMINI_KEY=your-api-key
```
**For DeepSeek:**
```
DEEPSEEK_KEY=your-api-key
```
### 3. Set Auth Token (Optional)
For secure access, set a token:
```
GATEWAY_TOKEN=your-secret-token
```
Then access with: `/?token=your-secret-token`
## Channels Setup
OpenClaw supports multiple messaging channels. Configure them in the Control UI or via environment variables:
| Channel | Environment Variable |
|---------|---------------------|
| Discord | `DISCORD_TOKEN` |
| Slack | `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN` |
| Telegram | `TELEGRAM_BOT_TOKEN` |
| WhatsApp | Configure via Control UI (pairing required) |
| Google Chat | Configure via Control UI |
| Signal | Configure via Control UI |
## Configuration
The gateway uses `~/.openclaw/openclaw.json` for configuration. Key settings:
```json
{
"gateway": {
"bind": "0.0.0.0",
"port": 7860,
"controlUi": {
"allowInsecureAuth": true
}
},
"agents": {
"defaults": {
"model": "anthropic/claude-sonnet-4-20250514"
}
}
}
```
## Documentation
- [Official Docs](https://docs.openclaw.ai/)
- [GitHub](https://github.com/openclaw/openclaw)
- [Discord](https://discord.gg/openclaw)
## License
MIT