Simford.Dong
commited on
Commit
·
480703a
1
Parent(s):
17b6773
docs: simplify README.md to focus on Feishu + Claude SDK configuration
Browse files
README.md
CHANGED
|
@@ -6,108 +6,41 @@ colorTo: purple
|
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
-
short_description: Lightweight, secure, customizable AI assistant
|
| 10 |
---
|
| 11 |
|
| 12 |
# NanoClaw AI Assistant
|
| 13 |
|
| 14 |
-
> Your own personal AI assistant.
|
| 15 |
|
| 16 |
-
This Hugging Face Space runs **NanoClaw**, a lightweight
|
| 17 |
-
|
| 18 |
-
## Features
|
| 19 |
-
|
| 20 |
-
- 🎛️ **Control UI** - Web-based dashboard for managing your assistant
|
| 21 |
-
- 💬 **WebChat** - Browser-based chat interface
|
| 22 |
-
- 📡 **WebSocket Gateway** - Real-time communication
|
| 23 |
-
- 🔌 **Multi-Channel Support** - WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, and more
|
| 24 |
-
- 🤖 **Multi-Model Support** - Anthropic, OpenAI, Gemini, DeepSeek, OpenRouter, etc.
|
| 25 |
-
- 🛠️ **Tool Support** - Browser automation, Canvas, Nodes, Cron, and more
|
| 26 |
|
| 27 |
## Quick Start
|
| 28 |
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
Visit the Space URL to access the Control UI:
|
| 32 |
-
```
|
| 33 |
-
https://sim4imgbed-openclaw.hf.space/
|
| 34 |
-
```
|
| 35 |
-
|
| 36 |
-
### 2. Configure API Keys
|
| 37 |
-
|
| 38 |
-
Set environment variables in the Space settings:
|
| 39 |
-
|
| 40 |
-
**For Anthropic Claude:**
|
| 41 |
-
```
|
| 42 |
-
ANTHROPIC_AUTH_TOKEN=your-sk-ant-key
|
| 43 |
-
# or OAuth: ANTHROPIC_AUTH_REFRESH_TOKEN=your-refresh-token
|
| 44 |
-
```
|
| 45 |
-
|
| 46 |
-
**For OpenAI:**
|
| 47 |
-
```
|
| 48 |
-
OPENAI_KEY=your-sk-key
|
| 49 |
-
```
|
| 50 |
-
|
| 51 |
-
**For Gemini:**
|
| 52 |
-
```
|
| 53 |
-
GEMINI_KEY=your-api-key
|
| 54 |
-
```
|
| 55 |
-
|
| 56 |
-
**For DeepSeek:**
|
| 57 |
-
```
|
| 58 |
-
DEEPSEEK_KEY=your-api-key
|
| 59 |
-
```
|
| 60 |
-
|
| 61 |
-
### 3. Set Auth Token (Optional)
|
| 62 |
-
|
| 63 |
-
For secure access, set a token:
|
| 64 |
-
```
|
| 65 |
-
GATEWAY_TOKEN=your-secret-token
|
| 66 |
-
```
|
| 67 |
-
|
| 68 |
-
Then access with: `/?token=your-secret-token`
|
| 69 |
-
|
| 70 |
-
## Channels Setup
|
| 71 |
|
| 72 |
-
|
|
|
|
|
|
|
| 73 |
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
| Feishu | `FEISHU_APP_ID`, `FEISHU_APP_SECRET`, `FEISHU_ENCRYPT_KEY`, `FEISHU_VERIFICATION_TOKEN` |
|
| 80 |
-
| WhatsApp | Configure via Control UI (pairing required) |
|
| 81 |
-
| Google Chat | Configure via Control UI |
|
| 82 |
-
| Signal | Configure via Control UI |
|
| 83 |
|
| 84 |
-
##
|
| 85 |
|
| 86 |
-
|
| 87 |
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
"gateway": {
|
| 91 |
-
"bind": "0.0.0.0",
|
| 92 |
-
"port": 7860,
|
| 93 |
-
"controlUi": {
|
| 94 |
-
"allowInsecureAuth": true
|
| 95 |
-
}
|
| 96 |
-
},
|
| 97 |
-
"agents": {
|
| 98 |
-
"defaults": {
|
| 99 |
-
"model": "anthropic/claude-sonnet-4-20250514"
|
| 100 |
-
}
|
| 101 |
-
}
|
| 102 |
-
}
|
| 103 |
-
```
|
| 104 |
|
| 105 |
-
##
|
| 106 |
|
| 107 |
-
- [
|
| 108 |
-
- [GitHub](https://github.com/openclaw/openclaw)
|
| 109 |
-
- [Discord](https://discord.gg/openclaw)
|
| 110 |
|
| 111 |
## License
|
| 112 |
|
| 113 |
-
MIT
|
|
|
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
+
short_description: Lightweight, secure, customizable AI assistant via Feishu
|
| 10 |
---
|
| 11 |
|
| 12 |
# NanoClaw AI Assistant
|
| 13 |
|
| 14 |
+
> Your own personal AI assistant. Optimized for Feishu (Lark) and powered by Claude Agent SDK. 🦀
|
| 15 |
|
| 16 |
+
This Hugging Face Space runs **NanoClaw**, a lightweight agent host optimized for security and performance.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
## Quick Start
|
| 19 |
|
| 20 |
+
1. **Configure Feishu**: Create an app in the [Feishu Developer Console](https://open.feishu.cn/), enable **WebSocket** (Long Connection) for events, and add the bot to your chat.
|
| 21 |
+
2. **Set Environment Variables**: In your Space settings, add the following **Secrets**:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
|
| 23 |
+
### 📡 Feishu (Lark)
|
| 24 |
+
- `FEISHU_APP_ID`: Your app ID.
|
| 25 |
+
- `FEISHU_APP_SECRET`: Your app secret.
|
| 26 |
|
| 27 |
+
### 🤖 LLM (CLIProxyAPI)
|
| 28 |
+
- `ANTHROPIC_BASE_URL`: Proxy endpoint (e.g., `https://simford-cpa.hf.space`).
|
| 29 |
+
- `ANTHROPIC_AUTH_TOKEN`: Your API token.
|
| 30 |
+
- `ANTHROPIC_MODEL`: Primary model (e.g., `gemini-2.5-pro`).
|
| 31 |
+
- `ANTHROPIC_SMALL_FAST_MODEL`: Fallback model (e.g., `gemini-2.5-flash`).
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
|
| 33 |
+
## Usage
|
| 34 |
|
| 35 |
+
Simply message your bot in Feishu. The first chat to message the bot will automatically be registered as the **Main Channel** (Admin).
|
| 36 |
|
| 37 |
+
- **Direct Messages**: No trigger word needed in the main channel.
|
| 38 |
+
- **Group Chats**: Use `@Andy` (or your configured assistant name) to trigger.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 39 |
|
| 40 |
+
## Deployment
|
| 41 |
|
| 42 |
+
The Docker image for this space is auto-generated from the [nanoclaw](https://github.com/sim4d/nanoclaw) repository.
|
|
|
|
|
|
|
| 43 |
|
| 44 |
## License
|
| 45 |
|
| 46 |
+
MIT
|