diff --git a/README.md b/README.md index c7b8680..fce389a 120000 --- a/README.md +++ b/README.md @@ -1 +1,116 @@ -README_zh.md \ No newline at end of file +[](https://mseep.ai/app/oaklight-weilink) + +# WeiLink + +[](https://pypi.org/project/weilink/) +[](https://pypi.org/project/weilink/#history) +[](https://github.com/Oaklight/weilink/releases) +[](https://opensource.org/licenses/MIT) +[](https://pypi.org/project/weilink/) + +轻量级 Python SDK,用于微信 iLink Bot 协议。 + +[English](README_en.md) + +## 特性 + +- **零运行时依赖** — AES 媒体加密通过 ctypes 调用 OpenSSL,纯 Python 自动兜底 +- **消息队列语义** — `login()` / `send()` / `recv()` 三个核心接口 +- **状态自动管理** — `context_token`、sync cursor 内部缓存,调用方无需关心 +- **凭证持久化** — 扫码登录后 token 自动保存,重启免登录 +- **输入状态** — 支持"对方正在输入中"指示器 +- **统一 CLI** — 单一 `weilink` 命令,包含 `admin` 和 `mcp` 子命令 +- **Web 管理面板** — 可选的浏览器 UI,支持会话管理、扫码登录,可 Docker 部署 +- **MCP 服务器** — 可选的 [MCP](https://modelcontextprotocol.io/) 集成,支持 stdio/SSE/streamable-http 传输(`pip install weilink[mcp]`) + +## 安装 + +```bash +pip install weilink +``` + +## 快速开始 + +```python +from weilink import WeiLink + +wl = WeiLink() +wl.login() + +# 接收消息 +messages = wl.recv() +for msg in messages: + print(f"{msg.from_user}: {msg.text}") + +# 回复 +wl.send(msg.from_user, "收到!") + +wl.close() +``` + +## 工作原理 + +WeiLink 封装了微信 iLink Bot 协议(ClawBot 插件的底层协议),提供消息队列式的收发接口: + +``` +login() → 扫码获取凭证(持久化) +recv() → 长轮询收消息(35 秒超时) +send() → 回复消息(自动关联 context_token) +``` + +### 重要限制 + +- **不能主动发起对话** — 用户必须先给 ClawBot 发消息,bot 才能回复 +- **24 小时窗口** — 用户超过 24 小时未发消息,bot 的消息会被丢弃 +- **腾讯可随时终止服务** — 不建议将核心业务完全依赖此协议 + +## 管理面板 + +内置 Web UI,支持会话管理、扫码登录和状态监控: + +```bash +pip install weilink[server] +weilink admin -p 8080 +``` + +
![]() 仪表盘 |
+![]() 用户详情 |
+![]() 消息历史 |
+![]() 扫码登录 |
+