cc工作前备份
This commit is contained in:
154
README.md
154
README.md
@@ -1,61 +1,125 @@
|
||||
# ZCLAW - AI Agent Platform
|
||||
# ZCLAW 🦞 — OpenClaw 定制版 (Tauri Desktop)
|
||||
|
||||
基于 OpenClaw 的 AI 代理平台,实现"随时随地、一个 IM 入口搞定一切"。
|
||||
像 AutoClaw (智谱) 和 QClaw (腾讯) 一样,对 [OpenClaw](https://github.com/openclaw/openclaw) 进行定制化封装,打造中文优先的 Tauri 桌面 AI 助手。
|
||||
|
||||
## 核心功能
|
||||
## 核心定位
|
||||
|
||||
- **远程执行系统**: 手机发消息 → 电脑执行 → 结果返回
|
||||
- **任务编排引擎**: 复杂任务自动拆解、多步骤执行
|
||||
- **多 Agent 协作**: Planner + Executor + Combiner 协作模式
|
||||
- **持续记忆系统**: 用户画像、行为学习、关系图谱
|
||||
- **主动服务系统**: 定时任务、智能提醒、主动推荐
|
||||
```
|
||||
OpenClaw Gateway (执行引擎)
|
||||
↕ WebSocket
|
||||
ZCLAW Tauri App (桌面 UI)
|
||||
+ 中文模型 Provider (GLM/Qwen/Kimi/MiniMax)
|
||||
+ 飞书 Channel Plugin
|
||||
+ 分身(Clone) 管理
|
||||
+ 自定义 Skills
|
||||
```
|
||||
|
||||
## 功能特色
|
||||
|
||||
- **基于 OpenClaw**: 真实工具执行 (bash/file/browser)、Skills 生态、MCP 协议、心跳引擎
|
||||
- **中文模型**: 智谱 GLM-5、通义千问、Kimi K2.5、MiniMax (OpenAI 兼容 API)
|
||||
- **飞书集成**: 飞书 Channel Plugin,在飞书中直接对话指挥电脑
|
||||
- **分身系统**: 多个独立 Agent 实例,各有自己的角色、记忆、配置
|
||||
- **Tauri 桌面**: Rust + React 19,体积小 (~10MB),性能好
|
||||
- **设置页面**: 对标 AutoClaw — 通用/模型/MCP/技能/IM/工作区/隐私
|
||||
|
||||
## 技术栈
|
||||
|
||||
- TypeScript 5.x
|
||||
- Node.js 22 LTS
|
||||
- OpenClaw SDK
|
||||
- SQLite + sqlite-vec
|
||||
- BullMQ (任务队列)
|
||||
- Koishi (IM 集成)
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 安装依赖
|
||||
pnpm install
|
||||
|
||||
# 开发模式
|
||||
pnpm dev
|
||||
|
||||
# 构建
|
||||
pnpm build
|
||||
```
|
||||
| 层级 | 技术 |
|
||||
|------|------|
|
||||
| **执行引擎** | OpenClaw Gateway (Node.js, ws://127.0.0.1:18789) |
|
||||
| **桌面壳** | Tauri 2.0 (Rust + React 19) |
|
||||
| **前端** | React 19 + TailwindCSS + Zustand + Lucide Icons |
|
||||
| **自定义插件** | TypeScript (OpenClaw Plugin API) |
|
||||
| **通信协议** | OpenClaw Gateway WebSocket Protocol v3 |
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
zclaw/
|
||||
├── src/
|
||||
│ ├── core/ # 核心系统
|
||||
│ │ ├── remote-execution/ # 远程执行
|
||||
│ │ ├── task-orchestration/ # 任务编排
|
||||
│ │ ├── multi-agent/ # 多 Agent 协作
|
||||
│ │ ├── memory/ # 持续记忆
|
||||
│ │ └── proactive/ # 主动服务
|
||||
│ ├── im/ # IM 集成
|
||||
│ │ ├── feishu/ # 飞书
|
||||
│ │ ├── wecom/ # 企业微信
|
||||
│ │ └── telegram/ # Telegram
|
||||
│ ├── skills/ # 场景化 Skills
|
||||
│ └── index.ts # 入口
|
||||
├── tests/ # 测试
|
||||
└── docs/ # 文档
|
||||
ZClaw/
|
||||
├── desktop/ # Tauri 桌面应用 (React 前端)
|
||||
│ ├── src/
|
||||
│ │ ├── components/ # UI 组件
|
||||
│ │ ├── store/ # Zustand 状态管理
|
||||
│ │ └── lib/gateway-client.ts # Gateway WebSocket 客户端
|
||||
│ └── src-tauri/ # Rust 后端 (TODO)
|
||||
│
|
||||
├── src/gateway/ # Gateway 管理层
|
||||
│ ├── manager.ts # OpenClaw 子进程管理
|
||||
│ ├── ws-client.ts # Node.js WebSocket 客户端
|
||||
│ └── index.ts
|
||||
│
|
||||
├── plugins/ # ZCLAW 自定义 OpenClaw 插件
|
||||
│ ├── zclaw-chinese-models/ # 中文模型 Provider (GLM/Qwen/Kimi/MiniMax)
|
||||
│ ├── zclaw-feishu/ # 飞书 Channel Plugin
|
||||
│ └── zclaw-ui/ # UI 扩展 RPC 方法
|
||||
│
|
||||
├── skills/ # 自定义 Skills
|
||||
│ ├── chinese-writing/ # 中文写作
|
||||
│ └── feishu-docs/ # 飞书文档操作
|
||||
│
|
||||
├── config/ # OpenClaw 默认配置
|
||||
│ ├── openclaw.default.json # Gateway 配置模板
|
||||
│ ├── SOUL.md # Agent 人格
|
||||
│ ├── AGENTS.md # Agent 指令
|
||||
│ ├── IDENTITY.md # Agent 身份
|
||||
│ └── USER.md # 用户偏好
|
||||
│
|
||||
├── scripts/setup.ts # 首次设置脚本
|
||||
├── docs/ # 文档
|
||||
│ ├── architecture-v2.md # 架构设计
|
||||
│ ├── deviation-analysis.md # 偏离分析报告
|
||||
│ └── autoclaw界面/ # AutoClaw 参考截图
|
||||
└── src/core/ # [归档] v1 旧代码
|
||||
```
|
||||
|
||||
## 开发计划
|
||||
## 快速开始
|
||||
|
||||
详见: temp/zclaw-final-plan.md
|
||||
### 1. 安装 OpenClaw
|
||||
|
||||
```bash
|
||||
# Windows
|
||||
iwr -useb https://openclaw.ai/install.ps1 | iex
|
||||
|
||||
# macOS / Linux
|
||||
curl -fsSL https://openclaw.ai/install.sh | bash
|
||||
```
|
||||
|
||||
### 2. 安装 ZCLAW
|
||||
|
||||
```bash
|
||||
git clone https://github.com/xxx/ZClaw.git
|
||||
cd ZClaw
|
||||
pnpm install
|
||||
pnpm setup # 注册插件 + 复制配置
|
||||
```
|
||||
|
||||
### 3. 配置 API Key
|
||||
|
||||
```bash
|
||||
openclaw configure # 交互式配置
|
||||
# 或手动编辑 ~/.openclaw/openclaw.json
|
||||
```
|
||||
|
||||
### 4. 启动
|
||||
|
||||
```bash
|
||||
openclaw gateway # 启动 OpenClaw Gateway
|
||||
cd desktop && pnpm tauri dev # 启动 Tauri 桌面应用
|
||||
```
|
||||
|
||||
## 对标参考
|
||||
|
||||
| 产品 | 基于 | IM 渠道 | 桌面框架 |
|
||||
|------|------|---------|----------|
|
||||
| **QClaw** (腾讯) | OpenClaw | 微信 + QQ | Electron |
|
||||
| **AutoClaw** (智谱) | OpenClaw | 飞书 | 自研 |
|
||||
| **ZCLAW** (本项目) | OpenClaw | 飞书 (+ 微信/QQ 计划中) | Tauri 2.0 |
|
||||
|
||||
## 文档
|
||||
|
||||
- [架构设计](docs/architecture-v2.md) — 完整的 v2 架构方案
|
||||
- [偏离分析](docs/deviation-analysis.md) — 与 QClaw/AutoClaw/OpenClaw 对标分析
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user