Merge branch 'sipeed:main' into feat/weixin-openclaw-port
This commit is contained in:
zhangmikoto
GitHub
commit
8d04fb7403
15 changed files with 323 additions and 810 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -59,3 +59,6 @@ cmd/telegram/
|
||||||
!web/backend/dist/
|
!web/backend/dist/
|
||||||
web/backend/dist/*
|
web/backend/dist/*
|
||||||
!web/backend/dist/.gitkeep
|
!web/backend/dist/.gitkeep
|
||||||
|
|
||||||
|
|
||||||
|
docker/data
|
||||||
796
README.md
796
README.md
|
|
@ -747,797 +747,5 @@ User Groups:
|
||||||
|
|
||||||
discord: <https://discord.gg/V4sAZ9XWpN>
|
discord: <https://discord.gg/V4sAZ9XWpN>
|
||||||
|
|
||||||
<img src="assets/wechat.png" alt="PicoClaw" width="512">
center">
|
WeChat:
|
||||||
<img src="assets/logo.webp" alt="PicoClaw" width="512">
|
<img src="assets/wechat.png" alt="WeChat group QR code" width="512">
|
||||||
|
|
||||||
<h1>PicoClaw: Ultra-Efficient AI Assistant in Go</h1>
|
|
||||||
|
|
||||||
<h3>$10 Hardware · <10MB RAM · <1s Boot · 皮皮虾，我们走！</h3>
|
|
||||||
<p>
|
|
||||||
<img src="https://img.shields.io/badge/Go-1.25+-00ADD8?style=flat&logo=go&logoColor=white" alt="Go">
|
|
||||||
<img src="https://img.shields.io/badge/Arch-x86__64%2C%20ARM64%2C%20MIPS%2C%20RISC--V%2C%20LoongArch-blue" alt="Hardware">
|
|
||||||
<img src="https://img.shields.io/badge/license-MIT-green" alt="License">
|
|
||||||
<br>
|
|
||||||
<a href="https://picoclaw.io"><img src="https://img.shields.io/badge/Website-picoclaw.io-blue?style=flat&logo=google-chrome&logoColor=white" alt="Website"></a>
|
|
||||||
<a href="https://docs.picoclaw.io/"><img src="https://img.shields.io/badge/Docs-Official-007acc?style=flat&logo=read-the-docs&logoColor=white" alt="Docs"></a>
|
|
||||||
<a href="https://deepwiki.com/sipeed/picoclaw"><img src="https://img.shields.io/badge/Wiki-DeepWiki-FFA500?style=flat&logo=wikipedia&logoColor=white" alt="Wiki"></a>
|
|
||||||
<br>
|
|
||||||
<a href="https://x.com/SipeedIO"><img src="https://img.shields.io/badge/X_(Twitter)-SipeedIO-black?style=flat&logo=x&logoColor=white" alt="Twitter"></a>
|
|
||||||
<a href="./assets/wechat.png"><img src="https://img.shields.io/badge/WeChat-Group-41d56b?style=flat&logo=wechat&logoColor=white"></a>
|
|
||||||
<a href="https://discord.gg/V4sAZ9XWpN"><img src="https://img.shields.io/badge/Discord-Community-4c60eb?style=flat&logo=discord&logoColor=white" alt="Discord"></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
[中文](README.zh.md) | [日本語](README.ja.md) | [Português](README.pt-br.md) | [Tiếng Việt](README.vi.md) | [Français](README.fr.md) | [Italiano](README.it.md) | [Bahasa Indonesia](README.id.md) | **English**
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
> **PicoClaw** is an independent open-source project initiated by [Sipeed](https://sipeed.com). It is written entirely in **Go** — not a fork of OpenClaw, NanoBot, or any other project.
|
|
||||||
|
|
||||||
🦐 PicoClaw is an ultra-lightweight personal AI Assistant inspired by [NanoBot](https://github.com/HKUDS/nanobot), refactored from the ground up in Go through a self-bootstrapping process, where the AI agent itself drove the entire architectural migration and code optimization.
|
|
||||||
|
|
||||||
⚡️ Runs on $10 hardware with <10MB RAM: That's 99% less memory than OpenClaw and 98% cheaper than a Mac mini!
|
|
||||||
|
|
||||||
<table align="center">
|
|
||||||
<tr align="center">
|
|
||||||
<td align="center" valign="top">
|
|
||||||
<p align="center">
|
|
||||||
<img src="assets/picoclaw_mem.gif" width="360" height="240">
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
<td align="center" valign="top">
|
|
||||||
<p align="center">
|
|
||||||
<img src="assets/licheervnano.png" width="400" height="240">
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
> [!CAUTION]
|
|
||||||
> **🚨 SECURITY & OFFICIAL CHANNELS / 安全声明**
|
|
||||||
>
|
|
||||||
> * **NO CRYPTO:** PicoClaw has **NO** official token/coin. All claims on `pump.fun` or other trading platforms are **SCAMS**.
|
|
||||||
>
|
|
||||||
> * **OFFICIAL DOMAIN:** The **ONLY** official website is **[picoclaw.io](https://picoclaw.io)**, and company website is **[sipeed.com](https://sipeed.com)**
|
|
||||||
> * **Warning:** Many `.ai/.org/.com/.net/...` domains are registered by third parties.
|
|
||||||
> * **Warning:** picoclaw is in early development now and may have unresolved network security issues. Do not deploy to production environments before the v1.0 release.
|
|
||||||
> * **Note:** picoclaw has recently merged a lot of PRs, which may result in a larger memory footprint (10–20MB) in the latest versions. We plan to prioritize resource optimization as soon as the current feature set reaches a stable state.
|
|
||||||
|
|
||||||
## 📢 News
|
|
||||||
|
|
||||||
2026-03-17 🚀 **v0.2.3 Released!** System tray UI (Windows & Linux), sub-agent status tracking (`spawn_status`), experimental gateway hot-reload, cron security gates, and 2 security fixes. PicoClaw now at **25K ⭐**!
|
|
||||||
|
|
||||||
2026-03-09 🎉 **v0.2.1 — Biggest update yet!** MCP protocol support, 4 new channels (Matrix/IRC/WeCom/Discord Proxy), 3 new providers (Kimi/Minimax/Avian), vision pipeline, JSONL memory store, and model routing.
|
|
||||||
|
|
||||||
2026-02-28 📦 **v0.2.0** released with Docker Compose support and Web UI launcher.
|
|
||||||
|
|
||||||
2026-02-26 🎉 PicoClaw hit **20K stars** in just 17 days! Channel auto-orchestration and capability interfaces landed.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Older news...</summary>
|
|
||||||
|
|
||||||
2026-02-16 🎉 PicoClaw hit 12K stars in one week! Community maintainer roles and [roadmap](ROADMAP.md) officially posted.
|
|
||||||
|
|
||||||
2026-02-13 🎉 PicoClaw hit 5000 stars in 4 days! Project Roadmap and Developer Group setup underway.
|
|
||||||
|
|
||||||
2026-02-09 🎉 **PicoClaw Launched!** Built in 1 day to bring AI Agents to $10 hardware with <10MB RAM. 🦐 PicoClaw，Let's Go！
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## ✨ Features
|
|
||||||
|
|
||||||
🪶 **Ultra-Lightweight**: <10MB Memory footprint — 99% smaller than OpenClaw core functionality.*
|
|
||||||
|
|
||||||
💰 **Minimal Cost**: Efficient enough to run on $10 Hardware — 98% cheaper than a Mac mini.
|
|
||||||
|
|
||||||
⚡️ **Lightning Fast**: 400X Faster startup time, boot in <1 second even on 0.6GHz single core.
|
|
||||||
|
|
||||||
🌍 **True Portability**: Single self-contained binary across RISC-V, ARM, MIPS, and x86, One-click to Go!
|
|
||||||
|
|
||||||
🤖 **AI-Bootstrapped**: Autonomous Go-native implementation — 95% Agent-generated core with human-in-the-loop refinement.
|
|
||||||
|
|
||||||
🔌 **MCP Support**: Native [Model Context Protocol](https://modelcontextprotocol.io/) integration — connect any MCP server to extend agent capabilities.
|
|
||||||
|
|
||||||
👁️ **Vision Pipeline**: Send images and files directly to the agent — automatic base64 encoding for multimodal LLMs.
|
|
||||||
|
|
||||||
🧠 **Smart Routing**: Rule-based model routing — simple queries go to lightweight models, saving API costs.
|
|
||||||
|
|
||||||
_*Recent versions may use 10–20MB due to rapid feature merges. Resource optimization is planned. Startup comparison based on 0.8GHz single-core benchmarks (see table below)._
|
|
||||||
|
|
||||||
| | OpenClaw | NanoBot | **PicoClaw** |
|
|
||||||
| ----------------------------- | ------------- | ------------------------ | ----------------------------------------- |
|
|
||||||
| **Language** | TypeScript | Python | **Go** |
|
|
||||||
| **RAM** | >1GB | >100MB | **< 10MB*** |
|
|
||||||
| **Startup**</br>(0.8GHz core) | >500s | >30s | **<1s** |
|
|
||||||
| **Cost** | Mac Mini $599 | Most Linux SBC </br>~$50 | **Any Linux Board**</br>**As low as $10** |
|
|
||||||
|
|
||||||
<img src="assets/compare.jpg" alt="PicoClaw" width="512">
|
|
||||||
|
|
||||||
> 📋 **[Hardware Compatibility List](docs/hardware-compatibility.md)** — See all tested boards, from $5 RISC-V to Raspberry Pi to Android phones. Your board not listed? Submit a PR!
|
|
||||||
|
|
||||||
## 🦾 Demonstration
|
|
||||||
|
|
||||||
### 🛠️ Standard Assistant Workflows
|
|
||||||
|
|
||||||
<table align="center">
|
|
||||||
<tr align="center">
|
|
||||||
<th><p align="center">🧩 Full-Stack Engineer</p></th>
|
|
||||||
<th><p align="center">🗂️ Logging & Planning Management</p></th>
|
|
||||||
<th><p align="center">🔎 Web Search & Learning</p></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="center"><p align="center"><img src="assets/picoclaw_code.gif" width="240" height="180"></p></td>
|
|
||||||
<td align="center"><p align="center"><img src="assets/picoclaw_memory.gif" width="240" height="180"></p></td>
|
|
||||||
<td align="center"><p align="center"><img src="assets/picoclaw_search.gif" width="240" height="180"></p></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="center">Develop • Deploy • Scale</td>
|
|
||||||
<td align="center">Schedule • Automate • Memory</td>
|
|
||||||
<td align="center">Discovery • Insights • Trends</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
### 📱 Run on old Android Phones
|
|
||||||
|
|
||||||
Give your decade-old phone a second life! Turn it into a smart AI Assistant with PicoClaw. Quick Start:
|
|
||||||
|
|
||||||
1. **Install [Termux](https://github.com/termux/termux-app)** (Download from [GitHub Releases](https://github.com/termux/termux-app/releases), or search in F-Droid / Google Play).
|
|
||||||
2. **Execute cmds**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Download the latest release from https://github.com/sipeed/picoclaw/releases
|
|
||||||
wget https://github.com/sipeed/picoclaw/releases/latest/download/picoclaw_Linux_arm64.tar.gz
|
|
||||||
tar xzf picoclaw_Linux_arm64.tar.gz
|
|
||||||
pkg install proot
|
|
||||||
termux-chroot ./picoclaw onboard
|
|
||||||
```
|
|
||||||
|
|
||||||
And then follow the instructions in the "Quick Start" section to complete the configuration!
|
|
||||||
|
|
||||||
<img src="assets/termux.jpg" alt="PicoClaw" width="512">
|
|
||||||
|
|
||||||
### 🐜 Innovative Low-Footprint Deploy
|
|
||||||
|
|
||||||
PicoClaw can be deployed on almost any Linux device!
|
|
||||||
|
|
||||||
- $9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(Ethernet) or W(WiFi6) version, for Minimal Home Assistant
|
|
||||||
- $30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), or $100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) for Automated Server Maintenance
|
|
||||||
- $50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) or $100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) for Smart Monitoring
|
|
||||||
|
|
||||||
<https://private-user-images.githubusercontent.com/83055338/547056448-e7b031ff-d6f5-4468-bcca-5726b6fecb5c.mp4>
|
|
||||||
|
|
||||||
🌟 More Deployment Cases Await！
|
|
||||||
|
|
||||||
## 📦 Install
|
|
||||||
|
|
||||||
### Install with precompiled binary
|
|
||||||
|
|
||||||
Download the binary for your platform from the [Releases](https://github.com/sipeed/picoclaw/releases) page.
|
|
||||||
|
|
||||||
### Install from source (latest features, recommended for development)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/sipeed/picoclaw.git
|
|
||||||
|
|
||||||
cd picoclaw
|
|
||||||
make deps
|
|
||||||
|
|
||||||
# Build, no need to install
|
|
||||||
make build
|
|
||||||
|
|
||||||
# Build for multiple platforms
|
|
||||||
make build-all
|
|
||||||
|
|
||||||
# Build for Raspberry Pi Zero 2 W (32-bit: make build-linux-arm; 64-bit: make build-linux-arm64)
|
|
||||||
make build-pi-zero
|
|
||||||
|
|
||||||
# Build And Install
|
|
||||||
make install
|
|
||||||
```
|
|
||||||
|
|
||||||
**Raspberry Pi Zero 2 W:** Use the binary that matches your OS: 32-bit Raspberry Pi OS → `make build-linux-arm`; 64-bit → `make build-linux-arm64`. Or run `make build-pi-zero` to build both.
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
For detailed guides, see the docs below. The README covers quick start only.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 1. Clone this repo
|
|
||||||
git clone https://github.com/sipeed/picoclaw.git
|
|
||||||
cd picoclaw
|
|
||||||
|
|
||||||
# 2. First run — auto-generates docker/data/config.json then exits
|
|
||||||
docker compose -f docker/docker-compose.yml --profile gateway up
|
|
||||||
# The container prints "First-run setup complete." and stops.
|
|
||||||
|
|
||||||
# 3. Set your API keys
|
|
||||||
vim docker/data/config.json # Set provider API keys, bot tokens, etc.
|
|
||||||
|
|
||||||
# 4. Start
|
|
||||||
docker compose -f docker/docker-compose.yml --profile gateway up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> **Docker Users**: By default, the Gateway listens on `127.0.0.1` which is not accessible from the host. If you need to access the health endpoints or expose ports, set `PICOCLAW_GATEWAY_HOST=0.0.0.0` in your environment or update `config.json`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 5. Check logs
|
|
||||||
docker compose -f docker/docker-compose.yml logs -f picoclaw-gateway
|
|
||||||
|
|
||||||
# 6. Stop
|
|
||||||
docker compose -f docker/docker-compose.yml --profile gateway down
|
|
||||||
```
|
|
||||||
|
|
||||||
### Launcher Mode (Web Console)
|
|
||||||
|
|
||||||
The `launcher` image includes all three binaries (`picoclaw`, `picoclaw-launcher`, `picoclaw-launcher-tui`) and starts the web console by default, which provides a browser-based UI for configuration and chat.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker compose -f docker/docker-compose.yml --profile launcher up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
Open http://localhost:18800 in your browser. The launcher manages the gateway process automatically.
|
|
||||||
|
|
||||||
> [!WARNING]
|
|
||||||
> The web console does not yet support authentication. Avoid exposing it to the public internet.
|
|
||||||
|
|
||||||
### Agent Mode (One-shot)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Ask a question
|
|
||||||
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent -m "What is 2+2?"
|
|
||||||
|
|
||||||
# Interactive mode
|
|
||||||
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent
|
|
||||||
```
|
|
||||||
|
|
||||||
### Update
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker compose -f docker/docker-compose.yml pull
|
|
||||||
docker compose -f docker/docker-compose.yml --profile gateway up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
### 🚀 Quick Start
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> Set your API Key in `~/.picoclaw/config.json`. Get API Keys: [Volcengine (CodingPlan)](https://console.volcengine.com) (LLM) · [OpenRouter](https://openrouter.ai/keys) (LLM) · [Zhipu](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) (LLM). Web search is optional — get a free [Tavily API](https://tavily.com) (1000 free queries/month) or [Brave Search API](https://brave.com/search/api) (2000 free queries/month).
|
|
||||||
|
|
||||||
**1. Initialize**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw onboard
|
|
||||||
```
|
|
||||||
|
|
||||||
**2. Configure** (`~/.picoclaw/config.json`)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"agents": {
|
|
||||||
"defaults": {
|
|
||||||
"workspace": "~/.picoclaw/workspace",
|
|
||||||
"model_name": "gpt-5.4",
|
|
||||||
"max_tokens": 8192,
|
|
||||||
"temperature": 0.7,
|
|
||||||
"max_tool_iterations": 20
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"model_list": [
|
|
||||||
{
|
|
||||||
"model_name": "ark-code-latest",
|
|
||||||
"model": "volcengine/ark-code-latest",
|
|
||||||
"api_key": "sk-your-api-key"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"model_name": "gpt-5.4",
|
|
||||||
"model": "openai/gpt-5.4",
|
|
||||||
"api_key": "your-api-key",
|
|
||||||
"request_timeout": 300
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"model_name": "claude-sonnet-4.6",
|
|
||||||
"model": "anthropic/claude-sonnet-4.6",
|
|
||||||
"api_key": "your-anthropic-key"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"tools": {
|
|
||||||
"web": {
|
|
||||||
"brave": {
|
|
||||||
"enabled": false,
|
|
||||||
"api_key": "YOUR_BRAVE_API_KEY",
|
|
||||||
"max_results": 5
|
|
||||||
},
|
|
||||||
"tavily": {
|
|
||||||
"enabled": false,
|
|
||||||
"api_key": "YOUR_TAVILY_API_KEY",
|
|
||||||
"max_results": 5
|
|
||||||
},
|
|
||||||
"duckduckgo": {
|
|
||||||
"enabled": true,
|
|
||||||
"max_results": 5
|
|
||||||
},
|
|
||||||
"perplexity": {
|
|
||||||
"enabled": false,
|
|
||||||
"api_key": "YOUR_PERPLEXITY_API_KEY",
|
|
||||||
"max_results": 5
|
|
||||||
},
|
|
||||||
"searxng": {
|
|
||||||
"enabled": false,
|
|
||||||
"base_url": "http://your-searxng-instance:8888",
|
|
||||||
"max_results": 5
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> **New**: The `model_list` configuration format allows zero-code provider addition. See [Model Configuration](#model-configuration-model_list) for details.
|
|
||||||
> `request_timeout` is optional and uses seconds. If omitted or set to `<= 0`, PicoClaw uses the default timeout (120s).
|
|
||||||
|
|
||||||
**3. Get API Keys**
|
|
||||||
|
|
||||||
* **LLM Provider**: [OpenRouter](https://openrouter.ai/keys) · [Zhipu](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) · [Anthropic](https://console.anthropic.com) · [OpenAI](https://platform.openai.com) · [Gemini](https://aistudio.google.com/api-keys)
|
|
||||||
* **Web Search** (optional):
|
|
||||||
* [Brave Search](https://brave.com/search/api) - Paid ($5/1000 queries, ~$5-6/month)
|
|
||||||
* [Perplexity](https://www.perplexity.ai) - AI-powered search with chat interface
|
|
||||||
* [SearXNG](https://github.com/searxng/searxng) - Self-hosted metasearch engine (free, no API key needed)
|
|
||||||
* [Tavily](https://tavily.com) - Optimized for AI Agents (1000 requests/month)
|
|
||||||
* DuckDuckGo - Built-in fallback (no API key required)
|
|
||||||
|
|
||||||
> **Note**: See `config.example.json` for a complete configuration template.
|
|
||||||
|
|
||||||
**4. Chat**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw agent -m "What is 2+2?"
|
|
||||||
```
|
|
||||||
|
|
||||||
That's it! You have a working AI assistant in 2 minutes.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 💬 Chat Apps
|
|
||||||
|
|
||||||
Talk to your picoclaw through Telegram, Discord, WhatsApp, Matrix, QQ, DingTalk, LINE, or WeCom
|
|
||||||
|
|
||||||
> **Note**: All webhook-based channels (LINE, WeCom, etc.) are served on a single shared Gateway HTTP server (`gateway.host`:`gateway.port`, default `127.0.0.1:18790`). There are no per-channel ports to configure. Note: Feishu uses WebSocket/SDK mode and does not use the shared HTTP webhook server.
|
|
||||||
|
|
||||||
| Channel | Setup |
|
|
||||||
| ------------ | ---------------------------------- |
|
|
||||||
| **Telegram** | Easy (just a token) |
|
|
||||||
| **Discord** | Easy (bot token + intents) |
|
|
||||||
| **WhatsApp** | Easy (native: QR scan; or bridge URL) |
|
|
||||||
| **Matrix** | Medium (homeserver + bot access token) |
|
|
||||||
| **QQ** | Easy (AppID + AppSecret) |
|
|
||||||
| **DingTalk** | Medium (app credentials) |
|
|
||||||
| **LINE** | Medium (credentials + webhook URL) |
|
|
||||||
| **WeCom AI Bot** | Medium (Token + AES key) |
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>Telegram</b> (Recommended)</summary>
|
|
||||||
|
|
||||||
**1. Create a bot**
|
|
||||||
|
|
||||||
* Open Telegram, search `@BotFather`
|
|
||||||
* Send `/newbot`, follow prompts
|
|
||||||
* Copy the token
|
|
||||||
|
|
||||||
**2. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"telegram": {
|
|
||||||
"enabled": true,
|
|
||||||
"token": "YOUR_BOT_TOKEN",
|
|
||||||
"allow_from": ["YOUR_USER_ID"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> Get your user ID from `@userinfobot` on Telegram.
|
|
||||||
|
|
||||||
**3. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
**4. Telegram command menu (auto-registered at startup)**
|
|
||||||
|
|
||||||
PicoClaw now keeps command definitions in one shared registry. On startup, Telegram will automatically register supported bot commands (for example `/start`, `/help`, `/show`, `/list`) so command menu and runtime behavior stay in sync.
|
|
||||||
Telegram command menu registration remains channel-local discovery UX; generic command execution is handled centrally in the agent loop via the commands executor.
|
|
||||||
|
|
||||||
If command registration fails (network/API transient errors), the channel still starts and PicoClaw retries registration in the background.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>Discord</b></summary>
|
|
||||||
|
|
||||||
**1. Create a bot**
|
|
||||||
|
|
||||||
* Go to <https://discord.com/developers/applications>
|
|
||||||
* Create an application → Bot → Add Bot
|
|
||||||
* Copy the bot token
|
|
||||||
|
|
||||||
**2. Enable intents**
|
|
||||||
|
|
||||||
* In the Bot settings, enable **MESSAGE CONTENT INTENT**
|
|
||||||
* (Optional) Enable **SERVER MEMBERS INTENT** if you plan to use allow lists based on member data
|
|
||||||
|
|
||||||
**3. Get your User ID**
|
|
||||||
* Discord Settings → Advanced → enable **Developer Mode**
|
|
||||||
* Right-click your avatar → **Copy User ID**
|
|
||||||
|
|
||||||
**4. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"discord": {
|
|
||||||
"enabled": true,
|
|
||||||
"token": "YOUR_BOT_TOKEN",
|
|
||||||
"allow_from": ["YOUR_USER_ID"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**5. Invite the bot**
|
|
||||||
|
|
||||||
* OAuth2 → URL Generator
|
|
||||||
* Scopes: `bot`
|
|
||||||
* Bot Permissions: `Send Messages`, `Read Message History`
|
|
||||||
* Open the generated invite URL and add the bot to your server
|
|
||||||
|
|
||||||
**Optional: Group trigger mode**
|
|
||||||
|
|
||||||
By default the bot responds to all messages in a server channel. To restrict responses to @-mentions only, add:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"discord": {
|
|
||||||
"group_trigger": { "mention_only": true }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also trigger by keyword prefixes (e.g. `!bot`):
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"discord": {
|
|
||||||
"group_trigger": { "prefixes": ["!bot"] }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**6. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>WhatsApp</b> (native via whatsmeow)</summary>
|
|
||||||
|
|
||||||
PicoClaw can connect to WhatsApp in two ways:
|
|
||||||
|
|
||||||
- **Native (recommended):** In-process using [whatsmeow](https://github.com/tulir/whatsmeow). No separate bridge. Set `"use_native": true` and leave `bridge_url` empty. On first run, scan the QR code with WhatsApp (Linked Devices). Session is stored under your workspace (e.g. `workspace/whatsapp/`). The native channel is **optional** to keep the default binary small; build with `-tags whatsapp_native` (e.g. `make build-whatsapp-native` or `go build -tags whatsapp_native ./cmd/...`).
|
|
||||||
- **Bridge:** Connect to an external WebSocket bridge. Set `bridge_url` (e.g. `ws://localhost:3001`) and keep `use_native` false.
|
|
||||||
|
|
||||||
**Configure (native)**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"whatsapp": {
|
|
||||||
"enabled": true,
|
|
||||||
"use_native": true,
|
|
||||||
"session_store_path": "",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
If `session_store_path` is empty, the session is stored in `<workspace>/whatsapp/`. Run `picoclaw gateway`; on first run, scan the QR code printed in the terminal with WhatsApp → Linked Devices.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>QQ</b></summary>
|
|
||||||
|
|
||||||
**1. Create a bot**
|
|
||||||
|
|
||||||
- Go to [QQ Open Platform](https://q.qq.com/#)
|
|
||||||
- Create an application → Get **AppID** and **AppSecret**
|
|
||||||
|
|
||||||
**2. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"qq": {
|
|
||||||
"enabled": true,
|
|
||||||
"app_id": "YOUR_APP_ID",
|
|
||||||
"app_secret": "YOUR_APP_SECRET",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> Set `allow_from` to empty to allow all users, or specify QQ numbers to restrict access.
|
|
||||||
|
|
||||||
**3. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>DingTalk</b></summary>
|
|
||||||
|
|
||||||
**1. Create a bot**
|
|
||||||
|
|
||||||
* Go to [Open Platform](https://open.dingtalk.com/)
|
|
||||||
* Create an internal app
|
|
||||||
* Copy Client ID and Client Secret
|
|
||||||
|
|
||||||
**2. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"dingtalk": {
|
|
||||||
"enabled": true,
|
|
||||||
"client_id": "YOUR_CLIENT_ID",
|
|
||||||
"client_secret": "YOUR_CLIENT_SECRET",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> Set `allow_from` to empty to allow all users, or specify DingTalk user IDs to restrict access.
|
|
||||||
|
|
||||||
**3. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>Matrix</b></summary>
|
|
||||||
|
|
||||||
**1. Prepare bot account**
|
|
||||||
|
|
||||||
* Use your preferred homeserver (e.g. `https://matrix.org` or self-hosted)
|
|
||||||
* Create a bot user and obtain its access token
|
|
||||||
|
|
||||||
**2. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"matrix": {
|
|
||||||
"enabled": true,
|
|
||||||
"homeserver": "https://matrix.org",
|
|
||||||
"user_id": "@your-bot:matrix.org",
|
|
||||||
"access_token": "YOUR_MATRIX_ACCESS_TOKEN",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**3. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
For full options (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), see [Matrix Channel Configuration Guide](docs/channels/matrix/README.md).
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>LINE</b></summary>
|
|
||||||
|
|
||||||
**1. Create a LINE Official Account**
|
|
||||||
|
|
||||||
- Go to [LINE Developers Console](https://developers.line.biz/)
|
|
||||||
- Create a provider → Create a Messaging API channel
|
|
||||||
- Copy **Channel Secret** and **Channel Access Token**
|
|
||||||
|
|
||||||
**2. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"line": {
|
|
||||||
"enabled": true,
|
|
||||||
"channel_secret": "YOUR_CHANNEL_SECRET",
|
|
||||||
"channel_access_token": "YOUR_CHANNEL_ACCESS_TOKEN",
|
|
||||||
"webhook_path": "/webhook/line",
|
|
||||||
"allow_from": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> LINE webhook is served on the shared Gateway server (`gateway.host`:`gateway.port`, default `127.0.0.1:18790`).
|
|
||||||
|
|
||||||
**3. Set up Webhook URL**
|
|
||||||
|
|
||||||
LINE requires HTTPS for webhooks. Use a reverse proxy or tunnel:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Example with ngrok (gateway default port is 18790)
|
|
||||||
ngrok http 18790
|
|
||||||
```
|
|
||||||
|
|
||||||
Then set the Webhook URL in LINE Developers Console to `https://your-domain/webhook/line` and enable **Use webhook**.
|
|
||||||
|
|
||||||
**4. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
> In group chats, the bot responds only when @mentioned. Replies quote the original message.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><b>WeCom (企业微信)</b></summary>
|
|
||||||
|
|
||||||
PicoClaw supports three types of WeCom integration:
|
|
||||||
|
|
||||||
**Option 1: WeCom Bot (Bot)** - Easier setup, supports group chats
|
|
||||||
**Option 2: WeCom App (Custom App)** - More features, proactive messaging, private chat only
|
|
||||||
**Option 3: WeCom AI Bot (AI Bot)** - Official AI Bot, streaming replies, supports group & private chat
|
|
||||||
|
|
||||||
See [WeCom AI Bot Configuration Guide](docs/channels/wecom/wecom_aibot/README.zh.md) for detailed setup instructions.
|
|
||||||
|
|
||||||
**Quick Setup - WeCom AI Bot:**
|
|
||||||
|
|
||||||
**1. Create an AI Bot**
|
|
||||||
|
|
||||||
* Go to WeCom Admin Console → AI Bot
|
|
||||||
* Create a new AI Bot → Set name, avatar, etc.
|
|
||||||
* Copy **Bot ID** and **Secret**
|
|
||||||
|
|
||||||
**2. Configure**
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"channels": {
|
|
||||||
"wecom_aibot": {
|
|
||||||
"enabled": true,
|
|
||||||
"bot_id": "YOUR_BOT_ID",
|
|
||||||
"secret": "YOUR_SECRET",
|
|
||||||
"allow_from": [],
|
|
||||||
"welcome_message": "Hello! How can I help you?"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**3. Run**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
picoclaw gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Note**: WeCom AI Bot uses streaming pull protocol — no reply timeout concerns. Long tasks (>30 seconds) automatically switch to `response_url` push delivery.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## <img src="assets/clawdchat-icon.png" width="24" height="24" alt="ClawdChat"> Join the Agent Social Network
|
|
||||||
|
|
||||||
Connect Picoclaw to the Agent Social Network simply by sending a single message via the CLI or any integrated Chat App.
|
|
||||||
|
|
||||||
**Read `https://clawdchat.ai/skill.md` and follow the instructions to join [ClawdChat.ai](https://clawdchat.ai)**
|
|
||||||
|
|
||||||
## 🖥️ CLI Reference
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ------------------------- | ----------------------------- |
|
|
||||||
| `picoclaw onboard` | Initialize config & workspace |
|
|
||||||
| `picoclaw agent -m "..."` | Chat with the agent |
|
|
||||||
| `picoclaw agent` | Interactive chat mode |
|
|
||||||
| `picoclaw gateway` | Start the gateway |
|
|
||||||
| `picoclaw status` | Show status |
|
|
||||||
| `picoclaw version` | Show version info |
|
|
||||||
| `picoclaw cron list` | List all scheduled jobs |
|
|
||||||
| `picoclaw cron add ...` | Add a scheduled job |
|
|
||||||
| `picoclaw cron disable` | Disable a scheduled job |
|
|
||||||
| `picoclaw cron remove` | Remove a scheduled job |
|
|
||||||
| `picoclaw skills list` | List installed skills |
|
|
||||||
| `picoclaw skills install` | Install a skill |
|
|
||||||
| `picoclaw migrate` | Migrate data from older versions |
|
|
||||||
| `picoclaw auth login` | Authenticate with providers |
|
|
||||||
|
|
||||||
### Scheduled Tasks / Reminders
|
|
||||||
|
|
||||||
PicoClaw supports scheduled reminders and recurring tasks through the `cron` tool:
|
|
||||||
|
|
||||||
* **One-time reminders**: "Remind me in 10 minutes" → triggers once after 10min
|
|
||||||
* **Recurring tasks**: "Remind me every 2 hours" → triggers every 2 hours
|
|
||||||
* **Cron expressions**: "Remind me at 9am daily" → uses cron expression
|
|
||||||
|
|
||||||
## 🤝 Contribute & Roadmap
|
|
||||||
|
|
||||||
PRs welcome! The codebase is intentionally small and readable. 🤗
|
|
||||||
|
|
||||||
See our full [Community Roadmap](https://github.com/sipeed/picoclaw/blob/main/ROADMAP.md).
|
|
||||||
|
|
||||||
Developer group building, join after your first merged PR!
|
|
||||||
|
|
||||||
User Groups:
|
|
||||||
|
|
||||||
discord: <https://discord.gg/V4sAZ9XWpN>
|
|
||||||
|
|
||||||
<img src="assets/wechat.png" alt="PicoClaw" width="512">
|
|
||||||
|
|
||||||
## <img src="assets/clawdchat-icon.png" width="24" height="24" alt="ClawdChat"> Join the Agent Social Network
|
|
||||||
|
|
||||||
Connect Picoclaw to the Agent Social Network simply by sending a single message via the CLI or any integrated Chat App.
|
|
||||||
|
|
||||||
**Read `https://clawdchat.ai/skill.md` and follow the instructions to join [ClawdChat.ai](https://clawdchat.ai)**
|
|
||||||
|
|
||||||
## 🖥️ CLI Reference
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ------------------------- | ----------------------------- |
|
|
||||||
| `picoclaw onboard` | Initialize config & workspace |
|
|
||||||
| `picoclaw agent -m "..."` | Chat with the agent |
|
|
||||||
| `picoclaw agent` | Interactive chat mode |
|
|
||||||
| `picoclaw gateway` | Start the gateway |
|
|
||||||
| `picoclaw status` | Show status |
|
|
||||||
| `picoclaw version` | Show version info |
|
|
||||||
| `picoclaw cron list` | List all scheduled jobs |
|
|
||||||
| `picoclaw cron add ...` | Add a scheduled job |
|
|
||||||
| `picoclaw cron disable` | Disable a scheduled job |
|
|
||||||
| `picoclaw cron remove` | Remove a scheduled job |
|
|
||||||
| `picoclaw skills list` | List installed skills |
|
|
||||||
| `picoclaw skills install` | Install a skill |
|
|
||||||
| `picoclaw migrate` | Migrate data from older versions |
|
|
||||||
| `picoclaw auth login` | Authenticate with providers |
|
|
||||||
| `picoclaw model` | View or switch the default model |
|
|
||||||
|
|
||||||
### Scheduled Tasks / Reminders
|
|
||||||
|
|
||||||
PicoClaw supports scheduled reminders and recurring tasks through the `cron` tool:
|
|
||||||
|
|
||||||
* **One-time reminders**: "Remind me in 10 minutes" → triggers once after 10min
|
|
||||||
* **Recurring tasks**: "Remind me every 2 hours" → triggers every 2 hours
|
|
||||||
* **Cron expressions**: "Remind me at 9am daily" → uses cron expression
|
|
||||||
|
|
||||||
## 🤝 Contribute & Roadmap
|
|
||||||
|
|
||||||
PRs welcome! The codebase is intentionally small and readable. 🤗
|
|
||||||
|
|
||||||
See our full [Community Roadmap](https://github.com/sipeed/picoclaw/blob/main/ROADMAP.md).
|
|
||||||
|
|
||||||
Developer group building, join after your first merged PR!
|
|
||||||
|
|
||||||
User Groups:
|
|
||||||
|
|
||||||
discord: <https://discord.gg/V4sAZ9XWpN>
|
|
||||||
|
|
||||||
<img src="assets/wechat.png" alt="PicoClaw" width="512">
|
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 61 KiB |
67
docker/Dockerfile.heavy
Normal file
67
docker/Dockerfile.heavy
Normal file
|
|
@ -0,0 +1,67 @@
|
||||||
|
# ============================================================
|
||||||
|
# Stage 1: Build the picoclaw binary
|
||||||
|
# ============================================================
|
||||||
|
FROM golang:1.26.0-alpine AS builder
|
||||||
|
|
||||||
|
RUN apk add --no-cache git make
|
||||||
|
|
||||||
|
WORKDIR /src
|
||||||
|
|
||||||
|
# Cache dependencies
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
|
||||||
|
# Copy source and build
|
||||||
|
COPY . .
|
||||||
|
RUN make build
|
||||||
|
|
||||||
|
# ============================================================
|
||||||
|
# Stage 2: Node.js runtime with Python + MCP support
|
||||||
|
# ============================================================
|
||||||
|
FROM node:24-alpine3.23
|
||||||
|
|
||||||
|
RUN apk add --no-cache \
|
||||||
|
ca-certificates \
|
||||||
|
curl \
|
||||||
|
git \
|
||||||
|
python3 \
|
||||||
|
py3-pip \
|
||||||
|
chromium \
|
||||||
|
jq
|
||||||
|
|
||||||
|
# Install Playwright browsers for agent-browser
|
||||||
|
ENV PLAYWRIGHT_BROWSERS_PATH=/opt/playwright-browsers
|
||||||
|
RUN npm install -g agent-browser && \
|
||||||
|
npx playwright install chromium && \
|
||||||
|
chmod -R o+rx $PLAYWRIGHT_BROWSERS_PATH
|
||||||
|
|
||||||
|
# Install uv
|
||||||
|
RUN curl -LsSf https://astral.sh/uv/install.sh | sh && \
|
||||||
|
ln -s /root/.local/bin/uv /usr/local/bin/uv && \
|
||||||
|
ln -s /root/.local/bin/uvx /usr/local/bin/uvx && \
|
||||||
|
uv --version
|
||||||
|
|
||||||
|
# Health check
|
||||||
|
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
|
||||||
|
CMD wget -q --spider http://localhost:18790/health || exit 1
|
||||||
|
|
||||||
|
# Copy binary
|
||||||
|
COPY --from=builder /src/build/picoclaw /usr/local/bin/picoclaw
|
||||||
|
|
||||||
|
# Reuse existing node user (UID/GID 1000) — rename to picoclaw
|
||||||
|
RUN deluser node 2>/dev/null; delgroup node 2>/dev/null; \
|
||||||
|
addgroup -g 1000 picoclaw 2>/dev/null; \
|
||||||
|
adduser -D -u 1000 -G picoclaw -h /home/picoclaw picoclaw 2>/dev/null || true
|
||||||
|
|
||||||
|
USER picoclaw
|
||||||
|
|
||||||
|
# Run onboard to create initial directories and config
|
||||||
|
RUN /usr/local/bin/picoclaw onboard
|
||||||
|
|
||||||
|
# Copy default workspace
|
||||||
|
COPY --chown=picoclaw:picoclaw workspace/ /home/picoclaw/.picoclaw/workspace/
|
||||||
|
|
||||||
|
VOLUME /home/picoclaw/.picoclaw/workspace
|
||||||
|
|
||||||
|
ENTRYPOINT ["picoclaw"]
|
||||||
|
CMD ["gateway"]
|
||||||
|
|
@ -46,3 +46,7 @@ Feishu (nom international : Lark) est une plateforme de collaboration d'entrepri
|
||||||
> `encrypt_key` et `verification_token` sont optionnels ; l'activation du chiffrement des événements est recommandée pour les environnements de production.
|
> `encrypt_key` et `verification_token` sont optionnels ; l'activation du chiffrement des événements est recommandée pour les environnements de production.
|
||||||
>
|
>
|
||||||
> Pour les références d'emojis personnalisés, voir : [Liste des emojis Feishu](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
> Pour les références d'emojis personnalisés, voir : [Liste des emojis Feishu](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
||||||
|
|
||||||
|
## Limitations de plateforme
|
||||||
|
|
||||||
|
> ⚠️ **Le canal Feishu ne prend pas en charge les appareils 32 bits.** Le SDK Feishu ne fournit que des builds 64 bits. Les architectures 32 bits (armv6, armv7, mipsle, etc.) ne peuvent pas utiliser le canal Feishu. Pour la messagerie sur des appareils 32 bits, utilisez Telegram, Discord ou OneBot.
|
||||||
|
|
|
||||||
|
|
@ -46,3 +46,7 @@
|
||||||
> `encrypt_key` と `verification_token` はオプションですが、本番環境ではイベント暗号化を有効にすることを推奨します。
|
> `encrypt_key` と `verification_token` はオプションですが、本番環境ではイベント暗号化を有効にすることを推奨します。
|
||||||
>
|
>
|
||||||
> カスタム絵文字の参考：[飛書絵文字リスト](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
> カスタム絵文字の参考：[飛書絵文字リスト](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
||||||
|
|
||||||
|
## プラットフォーム制限
|
||||||
|
|
||||||
|
> ⚠️ **飛書チャネルは 32 ビットデバイスをサポートしていません。** 飛書 SDK は 64 ビットビルドのみ提供しています。armv6 / armv7 / mipsle などの 32 ビットアーキテクチャでは飛書チャネルを使用できません。32 ビットデバイスでのメッセージングには、Telegram、Discord、または OneBot をご利用ください。
|
||||||
|
|
|
||||||
|
|
@ -46,3 +46,7 @@ Feishu (international name: Lark) is an enterprise collaboration platform by Byt
|
||||||
> `encrypt_key` and `verification_token` are optional; enabling event encryption is recommended for production environments.
|
> `encrypt_key` and `verification_token` are optional; enabling event encryption is recommended for production environments.
|
||||||
>
|
>
|
||||||
> For custom emoji references, see: [Feishu Emoji List](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
> For custom emoji references, see: [Feishu Emoji List](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
||||||
|
|
||||||
|
## Platform Limitations
|
||||||
|
|
||||||
|
> ⚠️ **Feishu channel does not support 32-bit devices.** The Feishu SDK only provides 64-bit builds. Devices running armv6, armv7, mipsle, or other 32-bit architectures cannot use the Feishu channel. For messaging on 32-bit devices, use Telegram, Discord, or OneBot instead.
|
||||||
|
|
|
||||||
|
|
@ -46,3 +46,7 @@ Feishu (nome internacional: Lark) é uma plataforma de colaboração empresarial
|
||||||
> `encrypt_key` e `verification_token` são opcionais; recomenda-se habilitar a criptografia de eventos em ambientes de produção.
|
> `encrypt_key` e `verification_token` são opcionais; recomenda-se habilitar a criptografia de eventos em ambientes de produção.
|
||||||
>
|
>
|
||||||
> Para referências de emojis personalizados, consulte: [Lista de Emojis do Feishu](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
> Para referências de emojis personalizados, consulte: [Lista de Emojis do Feishu](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
||||||
|
|
||||||
|
## Limitações de Plataforma
|
||||||
|
|
||||||
|
> ⚠️ **O canal Feishu não suporta dispositivos 32 bits.** O SDK do Feishu fornece apenas builds 64 bits. Arquiteturas 32 bits (armv6, armv7, mipsle, etc.) não podem usar o canal Feishu. Para mensagens em dispositivos 32 bits, use Telegram, Discord ou OneBot.
|
||||||
|
|
|
||||||
|
|
@ -46,3 +46,7 @@ Feishu (tên quốc tế: Lark) là nền tảng cộng tác doanh nghiệp củ
|
||||||
> `encrypt_key` và `verification_token` là tùy chọn; nên bật mã hóa sự kiện trong môi trường sản xuất.
|
> `encrypt_key` và `verification_token` là tùy chọn; nên bật mã hóa sự kiện trong môi trường sản xuất.
|
||||||
>
|
>
|
||||||
> Tham khảo emoji tùy chỉnh: [Danh sách Emoji Feishu](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
> Tham khảo emoji tùy chỉnh: [Danh sách Emoji Feishu](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
||||||
|
|
||||||
|
## Giới hạn nền tảng
|
||||||
|
|
||||||
|
> ⚠️ **Kênh Feishu không hỗ trợ thiết bị 32 bit.** SDK Feishu chỉ cung cấp bản build 64 bit. Các kiến trúc 32 bit (armv6, armv7, mipsle, v.v.) không thể sử dụng kênh Feishu. Để nhắn tin trên thiết bị 32 bit, hãy dùng Telegram, Discord hoặc OneBot.
|
||||||
|
|
|
||||||
|
|
@ -35,16 +35,13 @@
|
||||||
|
|
||||||
## 设置流程
|
## 设置流程
|
||||||
|
|
||||||
1. 前往 [飞书开放平台](https://open.feishu.cn/)（国际版用户请前往 [Lark 开放平台](https://open.larksuite.com/)）创建应用
|
1. 前往 [飞书开放平台](https://open.feishu.cn/)（国际版用户请前往 [Lark 开放平台](https://open.larksuite.com/)）创建应用程序
|
||||||
2. 在应用设置中启用**机器人**能力
|
2. 获取 App ID 和 App Secret
|
||||||
3. 创建版本并发布应用（应用发布后配置才会生效）
|
3. 配置事件订阅和Webhook URL
|
||||||
4. 获取 **App ID**（以 `cli_` 开头）和 **App Secret**
|
4. 设置加密(可选,生产环境建议启用)
|
||||||
5. 将 App ID 和 App Secret 填入 PicoClaw 配置文件
|
5. 将 App ID、App Secret、Encrypt Key 和 Verification Token(如果启用加密) 填入配置文件中
|
||||||
6. 运行 `picoclaw gateway` 启动服务
|
6. 自定义你希望 PicoClaw react 你消息时的表情（可选, Reference URL: [Feishu Emoji List](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce))
|
||||||
7. 在飞书中搜索机器人名称，开始对话
|
|
||||||
|
|
||||||
> PicoClaw 使用 WebSocket/SDK 模式连接飞书，无需配置公网回调地址或 Webhook URL。
|
## 平台限制
|
||||||
>
|
|
||||||
> `encrypt_key` 和 `verification_token` 为可选项，生产环境建议启用事件加密。
|
> ⚠️ **飞书通道不支持 32 位设备。** 飞书官方 SDK 仅提供 64 位构建，armv6 / armv7 / mipsle 等 32 位架构无法使用飞书通道。如需在 32 位设备上接入即时通讯，请改用 Telegram、Discord 或 OneBot 等通道。
|
||||||
>
|
|
||||||
> 自定义表情参考：[飞书表情列表](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
|
||||||
|
|
|
||||||
|
|
@ -26,6 +26,7 @@ import (
|
||||||
const (
|
const (
|
||||||
minIntervalMinutes = 5
|
minIntervalMinutes = 5
|
||||||
defaultIntervalMinutes = 30
|
defaultIntervalMinutes = 30
|
||||||
|
userTasksMarker = "Add your heartbeat tasks below this line:"
|
||||||
)
|
)
|
||||||
|
|
||||||
// HeartbeatHandler is the function type for handling heartbeat.
|
// HeartbeatHandler is the function type for handling heartbeat.
|
||||||
|
|
@ -232,7 +233,7 @@ func (hs *HeartbeatService) buildPrompt() string {
|
||||||
}
|
}
|
||||||
|
|
||||||
content := string(data)
|
content := string(data)
|
||||||
if len(content) == 0 {
|
if !heartbeatHasUserTasks(content) {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -284,6 +285,32 @@ Add your heartbeat tasks below this line:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func heartbeatHasUserTasks(content string) bool {
|
||||||
|
trimmed := strings.TrimSpace(content)
|
||||||
|
if trimmed == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
markerIdx := strings.Index(content, userTasksMarker)
|
||||||
|
if markerIdx < 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
tasksSection := content[markerIdx+len(userTasksMarker):]
|
||||||
|
for _, line := range strings.Split(tasksSection, "\n") {
|
||||||
|
trimmedLine := strings.TrimSpace(line)
|
||||||
|
if trimmedLine == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(trimmedLine, "#") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// sendResponse sends the heartbeat response to the last channel
|
// sendResponse sends the heartbeat response to the last channel
|
||||||
func (hs *HeartbeatService) sendResponse(response string) {
|
func (hs *HeartbeatService) sendResponse(response string) {
|
||||||
hs.mu.RLock()
|
hs.mu.RLock()
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@ package heartbeat
|
||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
|
@ -203,3 +204,47 @@ func TestHeartbeatFilePath(t *testing.T) {
|
||||||
t.Errorf("Expected HEARTBEAT.md at %s, but it doesn't exist", expectedPath)
|
t.Errorf("Expected HEARTBEAT.md at %s, but it doesn't exist", expectedPath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBuildPrompt_DefaultTemplateStaysIdle(t *testing.T) {
|
||||||
|
tmpDir, err := os.MkdirTemp("", "heartbeat-test-*")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to create temp dir: %v", err)
|
||||||
|
}
|
||||||
|
defer os.RemoveAll(tmpDir)
|
||||||
|
|
||||||
|
hs := NewHeartbeatService(tmpDir, 30, true)
|
||||||
|
hs.createDefaultHeartbeatTemplate()
|
||||||
|
|
||||||
|
if prompt := hs.buildPrompt(); prompt != "" {
|
||||||
|
t.Fatalf("buildPrompt() = %q, want empty prompt for untouched default template", prompt)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildPrompt_UserTasksAfterMarkerProducePrompt(t *testing.T) {
|
||||||
|
tmpDir, err := os.MkdirTemp("", "heartbeat-test-*")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to create temp dir: %v", err)
|
||||||
|
}
|
||||||
|
defer os.RemoveAll(tmpDir)
|
||||||
|
|
||||||
|
hs := NewHeartbeatService(tmpDir, 30, true)
|
||||||
|
hs.createDefaultHeartbeatTemplate()
|
||||||
|
|
||||||
|
path := filepath.Join(tmpDir, "HEARTBEAT.md")
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to read HEARTBEAT.md: %v", err)
|
||||||
|
}
|
||||||
|
updated := string(data) + "\n- Check unread Feishu messages\n"
|
||||||
|
if err := os.WriteFile(path, []byte(updated), 0o644); err != nil {
|
||||||
|
t.Fatalf("Failed to update HEARTBEAT.md: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
prompt := hs.buildPrompt()
|
||||||
|
if prompt == "" {
|
||||||
|
t.Fatal("buildPrompt() = empty, want non-empty prompt when user tasks are present")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "Check unread Feishu messages") {
|
||||||
|
t.Fatalf("prompt = %q, want user task content", prompt)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -94,13 +94,18 @@ func MatchAllowed(sender bus.SenderInfo, allowed string) bool {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
// isNumeric returns true if s consists entirely of digits.
|
// isNumeric returns true if s consists entirely of digits, allowing for an optional leading minus sign
|
||||||
|
// (required for Telegram group/channel IDs like -1001234567890).
|
||||||
func isNumeric(s string) bool {
|
func isNumeric(s string) bool {
|
||||||
if s == "" {
|
if s == "" {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
for _, r := range s {
|
start := 0
|
||||||
if r < '0' || r > '9' {
|
if s[0] == '-' && len(s) > 1 {
|
||||||
|
start = 1
|
||||||
|
}
|
||||||
|
for i := start; i < len(s); i++ {
|
||||||
|
if s[i] < '0' || s[i] > '9' {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -97,6 +97,15 @@ func TestMatchAllowed(t *testing.T) {
|
||||||
allowed: "654321",
|
allowed: "654321",
|
||||||
want: false,
|
want: false,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "negative numeric ID matches PlatformID",
|
||||||
|
sender: bus.SenderInfo{
|
||||||
|
Platform: "telegram",
|
||||||
|
PlatformID: "-1001234567890",
|
||||||
|
},
|
||||||
|
allowed: "-1001234567890",
|
||||||
|
want: true,
|
||||||
|
},
|
||||||
// Username matching
|
// Username matching
|
||||||
{
|
{
|
||||||
name: "@username matches Username",
|
name: "@username matches Username",
|
||||||
|
|
@ -238,6 +247,9 @@ func TestIsNumeric(t *testing.T) {
|
||||||
{"abc", false},
|
{"abc", false},
|
||||||
{"12a34", false},
|
{"12a34", false},
|
||||||
{"telegram", false},
|
{"telegram", false},
|
||||||
|
{"-1001234567890", true},
|
||||||
|
{"-", false},
|
||||||
|
{"-12a34", false},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
|
|
|
||||||
129
workspace/skills/agent-browser/SKILL.md
Normal file
129
workspace/skills/agent-browser/SKILL.md
Normal file
|
|
@ -0,0 +1,129 @@
|
||||||
|
---
|
||||||
|
name: agent-browser
|
||||||
|
description: "Browser automation via agent-browser CLI. Use when the user needs to navigate websites, fill forms, click buttons, take screenshots, extract data, or test web apps."
|
||||||
|
metadata: {"nanobot":{"emoji":"🌐","requires":{"bins":["agent-browser"]},"install":[{"id":"npm","kind":"npm","package":"agent-browser","global":true,"bins":["agent-browser"],"label":"Install agent-browser (npm)"}]}}
|
||||||
|
---
|
||||||
|
|
||||||
|
# Agent Browser
|
||||||
|
|
||||||
|
CLI browser automation via Chrome/Chromium CDP. Install: `npm i -g agent-browser && agent-browser install`.
|
||||||
|
|
||||||
|
**Before using this skill**, verify the tool is available by running `which agent-browser`. If the command is not found, tell the user that browser automation requires the `agent-browser` CLI and Chromium, which are only available in the heavy container image. Do not attempt to install it at runtime.
|
||||||
|
|
||||||
|
## Core Workflow
|
||||||
|
|
||||||
|
1. `agent-browser open <url>` — navigate
|
||||||
|
2. `agent-browser snapshot -i` — get interactive elements with refs (`@e1`, `@e2`, ...)
|
||||||
|
3. Interact using refs — `click @e1`, `fill @e2 "text"`
|
||||||
|
4. Re-snapshot after any navigation or DOM change — refs are invalidated
|
||||||
|
|
||||||
|
```bash
|
||||||
|
agent-browser open https://example.com/form
|
||||||
|
agent-browser snapshot -i
|
||||||
|
# @e1 [input] "Email", @e2 [input] "Password", @e3 [button] "Submit"
|
||||||
|
agent-browser fill @e1 "user@example.com"
|
||||||
|
agent-browser fill @e2 "secret"
|
||||||
|
agent-browser click @e3
|
||||||
|
agent-browser wait --load networkidle
|
||||||
|
agent-browser snapshot -i
|
||||||
|
```
|
||||||
|
|
||||||
|
Chain commands with `&&` when you don't need intermediate output:
|
||||||
|
```bash
|
||||||
|
agent-browser open https://example.com && agent-browser wait --load networkidle && agent-browser snapshot -i
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Navigation
|
||||||
|
agent-browser open <url>
|
||||||
|
agent-browser close
|
||||||
|
|
||||||
|
# Snapshot
|
||||||
|
agent-browser snapshot -i # Interactive elements with refs
|
||||||
|
agent-browser snapshot -s "#selector" # Scope to CSS selector
|
||||||
|
|
||||||
|
# Interaction (use @refs from snapshot)
|
||||||
|
agent-browser click @e1
|
||||||
|
agent-browser fill @e2 "text" # Clear + type
|
||||||
|
agent-browser type @e2 "text" # Type without clearing
|
||||||
|
agent-browser select @e1 "option"
|
||||||
|
agent-browser check @e1
|
||||||
|
agent-browser press Enter
|
||||||
|
agent-browser scroll down 500
|
||||||
|
|
||||||
|
# Get info
|
||||||
|
agent-browser get text @e1
|
||||||
|
agent-browser get url
|
||||||
|
agent-browser get title
|
||||||
|
|
||||||
|
# Wait
|
||||||
|
agent-browser wait @e1 # Wait for element
|
||||||
|
agent-browser wait --load networkidle # Wait for network idle
|
||||||
|
agent-browser wait --url "**/dashboard" # Wait for URL pattern
|
||||||
|
agent-browser wait --text "Welcome" # Wait for text
|
||||||
|
agent-browser wait 2000 # Wait ms
|
||||||
|
|
||||||
|
# Capture
|
||||||
|
agent-browser screenshot # Screenshot to temp dir
|
||||||
|
agent-browser screenshot --full # Full page
|
||||||
|
agent-browser screenshot --annotate # With numbered element labels ([N] -> @eN)
|
||||||
|
agent-browser pdf output.pdf
|
||||||
|
|
||||||
|
# Semantic locators (when refs unavailable)
|
||||||
|
agent-browser find text "Sign In" click
|
||||||
|
agent-browser find label "Email" fill "user@test.com"
|
||||||
|
agent-browser find role button click --name "Submit"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Option 1: Import from user's running Chrome
|
||||||
|
agent-browser --auto-connect state save ./auth.json
|
||||||
|
agent-browser --state ./auth.json open https://app.example.com
|
||||||
|
|
||||||
|
# Option 2: Persistent profile
|
||||||
|
agent-browser --profile ~/.myapp open https://app.example.com/login
|
||||||
|
# ... login once, all future runs are authenticated
|
||||||
|
|
||||||
|
# Option 3: Session name (auto-save/restore)
|
||||||
|
agent-browser --session-name myapp open https://app.example.com/login
|
||||||
|
# ... login, close, next run state is restored
|
||||||
|
|
||||||
|
# Option 4: State file
|
||||||
|
agent-browser state save auth.json
|
||||||
|
agent-browser state load auth.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## Iframes
|
||||||
|
|
||||||
|
Iframe content is inlined in snapshots. Interact with iframe refs directly — no frame switch needed.
|
||||||
|
|
||||||
|
## Parallel Sessions
|
||||||
|
|
||||||
|
```bash
|
||||||
|
agent-browser --session s1 open https://site-a.com
|
||||||
|
agent-browser --session s2 open https://site-b.com
|
||||||
|
agent-browser session list
|
||||||
|
```
|
||||||
|
|
||||||
|
## JavaScript Eval
|
||||||
|
|
||||||
|
```bash
|
||||||
|
agent-browser eval 'document.title'
|
||||||
|
|
||||||
|
# Complex JS — use --stdin to avoid shell quoting issues
|
||||||
|
agent-browser eval --stdin <<'EVALEOF'
|
||||||
|
JSON.stringify(Array.from(document.querySelectorAll("a")).map(a => a.href))
|
||||||
|
EVALEOF
|
||||||
|
```
|
||||||
|
|
||||||
|
## Cleanup
|
||||||
|
|
||||||
|
Always close sessions when done:
|
||||||
|
```bash
|
||||||
|
agent-browser close
|
||||||
|
agent-browser --session s1 close
|
||||||
|
```
|
||||||
Loading…
Add table
Reference in a new issue