refactor: 统一项目名称从OpenFang到ZCLAW
Some checks failed
CI / Lint & TypeCheck (push) Has been cancelled
CI / Unit Tests (push) Has been cancelled
CI / Build Frontend (push) Has been cancelled
CI / Rust Check (push) Has been cancelled
CI / Security Scan (push) Has been cancelled
CI / E2E Tests (push) Has been cancelled

重构所有代码和文档中的项目名称,将OpenFang统一更新为ZCLAW。包括:
- 配置文件中的项目名称
- 代码注释和文档引用
- 环境变量和路径
- 类型定义和接口名称
- 测试用例和模拟数据

同时优化部分代码结构,移除未使用的模块,并更新相关依赖项。
This commit is contained in:
iven
2026-03-27 07:36:03 +08:00
parent 4b08804aa9
commit 0d4fa96b82
226 changed files with 7288 additions and 5788 deletions

View File

@@ -1,7 +1,7 @@
# ZCLAW v2 架构设计 — 基于 OpenClaw 定制化
# ZCLAW v2 架构设计 — 基于 ZCLAW 定制化
**日期**: 2026-03-11
**定位**: 像 AutoClaw 一样,对 OpenClaw 进行定制化封装,打造 Tauri 桌面版
**定位**: 像 AutoClaw 一样,对 ZCLAW 进行定制化封装,打造 Tauri 桌面版
---
@@ -22,14 +22,14 @@
│ │ Tauri Commands │
│ ┌──────────────────────────────────────────────────┐ │
│ │ Rust Sidecar / Bridge │ │
│ │ • 管理 OpenClaw Gateway 子进程生命周期 │ │
│ │ • 管理 ZCLAW Gateway 子进程生命周期 │ │
│ │ • WebSocket 客户端连接 Gateway │ │
│ │ • 转发 Gateway 事件到前端 │ │
│ └──────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────┘
│ WebSocket (ws://127.0.0.1:18789)
┌─────────────────────────────────────────────────────────┐
OpenClaw Gateway (Node.js daemon) │
ZCLAW Gateway (Node.js daemon) │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌───────────┐ │
│ │ Agent │ │ Skills │ │ Sessions │ │ Heartbeat │ │
│ │ Runtime │ │ System │ │ Manager │ │ Engine │ │
@@ -65,9 +65,9 @@
## 二、核心设计决策
### 1. OpenClaw 作为执行引擎
### 1. ZCLAW 作为执行引擎
**不重新发明轮子**OpenClaw 已经实现了:
**不重新发明轮子**ZCLAW 已经实现了:
- ✅ 真实工具执行 (bash/file/browser)
- ✅ Skills 系统 (SKILL.md + 渐进式披露)
- ✅ MCP 协议支持
@@ -85,11 +85,11 @@ AutoClaw 用的是自己的桌面框架QClaw 用 Electron。我们用 **Tauri
- 更小体积 (~10MB vs Electron ~150MB)
- 更好性能 (Rust native)
- 系统级集成能力
- 管理 OpenClaw Gateway 子进程
- 管理 ZCLAW Gateway 子进程
### 3. 自定义插件做差异化
通过 OpenClaw 的 Plugin API 添加中国特色功能:
通过 ZCLAW 的 Plugin API 添加中国特色功能:
| 插件 | 功能 |
|------|------|
@@ -109,7 +109,7 @@ ZClaw/
│ ├── src-tauri/ # Rust 后端
│ │ ├── src/
│ │ │ ├── main.rs # Tauri 入口
│ │ │ ├── gateway.rs # OpenClaw Gateway 子进程管理
│ │ │ ├── gateway.rs # ZCLAW Gateway 子进程管理
│ │ │ ├── ws_client.rs # WebSocket 客户端
│ │ │ └── commands.rs # Tauri Commands (前端调用)
│ │ ├── Cargo.toml
@@ -141,7 +141,7 @@ ZClaw/
│ │ └── protocol.ts # Gateway 协议类型定义
│ └── package.json
├── plugins/ # ZCLAW 自定义 OpenClaw 插件
├── plugins/ # ZCLAW 自定义 ZCLAW 插件
│ ├── zclaw-feishu/ # 飞书频道插件
│ │ ├── index.ts
│ │ ├── plugin.json # 插件清单
@@ -173,7 +173,7 @@ ZClaw/
│ └── SKILL.md
├── config/ # ZCLAW 默认配置
│ ├── openclaw.default.json # 预设的 OpenClaw 配置
│ ├── zclaw.default.json # 预设的 ZCLAW 配置
│ ├── SOUL.md # 默认人格
│ ├── AGENTS.md # 默认 Agent 指令
│ ├── IDENTITY.md # 默认身份
@@ -181,7 +181,7 @@ ZClaw/
├── scripts/ # 构建/安装脚本
│ ├── setup.ts # 首次设置脚本
│ ├── install-openclaw.ts # OpenClaw 安装检测
│ ├── install-zclaw.ts # ZCLAW 安装检测
│ └── register-plugins.ts # 注册自定义插件
├── docs/
@@ -204,16 +204,16 @@ ZClaw/
| AutoClaw 功能 | ZCLAW 实现 |
|---|---|
| **通用** (账号/主题/开机启动/工具调用显示) | Tauri 窗口设置 + Gateway config |
| **用量统计** (会话/消息/Token 按模型分) | 读取 OpenClaw sessions JSONL + 统计 |
| **用量统计** (会话/消息/Token 按模型分) | 读取 ZCLAW sessions JSONL + 统计 |
| **积分详情** | 自定义积分系统 (可选) |
| **模型与API** (内置+自定义模型+Gateway URL) | `openclaw config` + Provider Plugin |
| **MCP 服务** (File System/Web Fetch/+添加) | 读取 OpenClaw MCP 配置 + UI 管理 |
| **模型与API** (内置+自定义模型+Gateway URL) | `zclaw config` + Provider Plugin |
| **MCP 服务** (File System/Web Fetch/+添加) | 读取 ZCLAW MCP 配置 + UI 管理 |
| **技能** (SKILL.md 管理/额外目录) | 读取 Skills 目录 + UI 管理 |
| **IM 频道** (添加/管理/快速添加飞书) | Channel Plugin 配置 UI |
| **工作区** (项目目录/文件限制/上下文保存/文件监听) | `agents.defaults.workspace` + sandbox 配置 |
| **数据与隐私** (本地路径/优化计划) | OpenClaw 数据目录 + 隐私配置 |
| **数据与隐私** (本地路径/优化计划) | ZCLAW 数据目录 + 隐私配置 |
| **提交反馈** | 自定义反馈表单 |
| **关于** (版本/更新) | 显示 ZCLAW + OpenClaw 版本 |
| **关于** (版本/更新) | 显示 ZCLAW + ZCLAW 版本 |
### AutoClaw 主界面 → ZCLAW 对标
@@ -231,7 +231,7 @@ ZClaw/
## 五、WebSocket 通信协议
ZCLAW Tauri 客户端通过标准 OpenClaw Gateway 协议通信:
ZCLAW Tauri 客户端通过标准 ZCLAW Gateway 协议通信:
### 连接握手
```json
@@ -277,7 +277,7 @@ tick → 定时心跳
## 六、开发分期
### Phase 1: 基础连通 (当前优先)
1. 安装 OpenClaw 并验证 Gateway 可运行
1. 安装 ZCLAW 并验证 Gateway 可运行
2. 创建 Tauri 项目结构 (保留现有 desktop/)
3. 实现 Gateway 子进程管理 (Rust sidecar)
4. 实现 WebSocket 客户端连接
@@ -286,7 +286,7 @@ tick → 定时心跳
### Phase 2: 自定义插件
1. 实现 `@zclaw/chinese-models` Provider Plugin (智谱GLM/Qwen/Kimi)
2. 实现 `@zclaw/feishu` Channel Plugin
3. 注册插件到 OpenClaw Gateway
3. 注册插件到 ZCLAW Gateway
### Phase 3: 完整 UI
1. 实现设置页面体系 (对标 AutoClaw 10 个页面)
@@ -310,18 +310,18 @@ tick → 定时心跳
- `plugins/zclaw-feishu/` 可复用之前的飞书适配器代码
### 废弃
- `src/core/remote-execution/`OpenClaw 自带工具执行
- `src/core/task-orchestration/`OpenClaw Agent Loop 自带
- `src/core/multi-agent/` → 改为 OpenClaw agents.list 多 Agent
- `src/core/memory/`OpenClaw Memory Plugin 自带
- `src/core/proactive/`OpenClaw Heartbeat Engine 自带
- `src/im/gateway.ts`OpenClaw Channel 系统自带
- `src/app.ts`OpenClaw Gateway 就是 app
- `src/core/remote-execution/`ZCLAW 自带工具执行
- `src/core/task-orchestration/`ZCLAW Agent Loop 自带
- `src/core/multi-agent/` → 改为 ZCLAW agents.list 多 Agent
- `src/core/memory/`ZCLAW Memory Plugin 自带
- `src/core/proactive/`ZCLAW Heartbeat Engine 自带
- `src/im/gateway.ts`ZCLAW Channel 系统自带
- `src/app.ts`ZCLAW Gateway 就是 app
- `src/api/` → 通过 WebSocket + Tauri Commands 替代
- `src/db/`OpenClaw 自带 SQLite
- `src/config/`OpenClaw 配置系统替代
- `src/db/`ZCLAW 自带 SQLite
- `src/config/`ZCLAW 配置系统替代
---
*本架构设计基于对 OpenClaw 官方文档 (docs.openclaw.ai) 的深度研究,
*本架构设计基于对 ZCLAW 官方文档 (docs.zclaw.ai) 的深度研究,
参考 AutoClaw v0.2.12 的 13 张界面截图进行功能对标。*