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
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:
@@ -1,12 +1,12 @@
|
||||
# OpenFang Kernel 配置指南
|
||||
# ZCLAW Kernel 配置指南
|
||||
|
||||
> ⚠️ **已归档**: 此文档仅作历史参考。ZCLAW 现在使用内部 Kernel 架构,无需启动外部 OpenFang 进程。请参阅 [快速启动指南](../quick-start.md) 和 [模型配置指南](../knowledge-base/configuration.md)。
|
||||
> ⚠️ **已归档**: 此文档仅作历史参考。ZCLAW 现在使用内部 Kernel 架构,无需启动外部 ZCLAW 进程。请参阅 [快速启动指南](../quick-start.md) 和 [模型配置指南](../knowledge-base/configuration.md)。
|
||||
|
||||
> 本文档帮助你正确配置 OpenFang Kernel,作为 ZCLAW 的后端执行引擎。
|
||||
> 本文档帮助你正确配置 ZCLAW Kernel,作为 ZCLAW 的后端执行引擎。
|
||||
|
||||
## 概述
|
||||
|
||||
OpenFang 是一个用 Rust 构建的生产级 Agent 操作系统(Agent Operating System)。与传统的聊天机器人框架不同,OpenFang 采用"主动执行"范式:Agent 能够按计划自主唤醒、完成任务并报告结果,而无需用户持续提示。
|
||||
ZCLAW 是一个用 Rust 构建的生产级 Agent 操作系统(Agent Operating System)。与传统的聊天机器人框架不同,ZCLAW 采用"主动执行"范式:Agent 能够按计划自主唤醒、完成任务并报告结果,而无需用户持续提示。
|
||||
|
||||
### 核心特性
|
||||
|
||||
@@ -31,7 +31,7 @@ OpenFang 是一个用 Rust 构建的生产级 Agent 操作系统(Agent Operati
|
||||
|
||||
### 依赖项
|
||||
|
||||
OpenFang 是一个独立的单二进制文件(~32MB),无外部依赖。但以下工具可能对某些功能必要:
|
||||
ZCLAW 是一个独立的单二进制文件(~32MB),无外部依赖。但以下工具可能对某些功能必要:
|
||||
|
||||
- **FFmpeg**:视频处理 Hand (Clip) 需要
|
||||
- **yt-dlp**:YouTube 视频下载需要
|
||||
@@ -46,18 +46,18 @@ OpenFang 是一个独立的单二进制文件(~32MB),无外部依赖。但
|
||||
|
||||
```powershell
|
||||
# 使用 PowerShell
|
||||
iwr -useb https://openfang.sh/install.ps1 | iex
|
||||
iwr -useb https://zclaw.sh/install.ps1 | iex
|
||||
```
|
||||
|
||||
#### macOS / Linux
|
||||
|
||||
```bash
|
||||
curl -fsSL https://openfang.sh/install.sh | bash
|
||||
curl -fsSL https://zclaw.sh/install.sh | bash
|
||||
```
|
||||
|
||||
### 方式二:手动下载
|
||||
|
||||
1. 访问 [GitHub Releases](https://github.com/RightNow-AI/openfang/releases)
|
||||
1. 访问 [GitHub Releases](https://github.com/RightNow-AI/zclaw/releases)
|
||||
2. 下载对应平台的二进制文件
|
||||
3. 将文件放入 PATH 目录
|
||||
|
||||
@@ -65,23 +65,23 @@ curl -fsSL https://openfang.sh/install.sh | bash
|
||||
|
||||
```powershell
|
||||
# 下载后移动到用户目录
|
||||
move openfang.exe C:\Users\<你的用户名>\.local\bin\
|
||||
move zclaw.exe C:\Users\<你的用户名>\.local\bin\
|
||||
```
|
||||
|
||||
#### macOS / Linux
|
||||
|
||||
```bash
|
||||
chmod +x openfang
|
||||
sudo mv openfang /usr/local/bin/
|
||||
chmod +x zclaw
|
||||
sudo mv zclaw /usr/local/bin/
|
||||
```
|
||||
|
||||
### 方式三:从源码编译
|
||||
|
||||
```bash
|
||||
git clone https://github.com/RightNow-AI/openfang.git
|
||||
cd openfang
|
||||
git clone https://github.com/RightNow-AI/zclaw.git
|
||||
cd zclaw
|
||||
cargo build --release
|
||||
# 编译产物位于 target/release/openfang
|
||||
# 编译产物位于 target/release/zclaw
|
||||
```
|
||||
|
||||
---
|
||||
@@ -93,15 +93,15 @@ cargo build --release
|
||||
首次使用需要初始化配置文件:
|
||||
|
||||
```bash
|
||||
openfang init
|
||||
zclaw init
|
||||
```
|
||||
|
||||
这将在 `~/.openfang/` 目录下创建以下结构:
|
||||
这将在 `~/.zclaw/` 目录下创建以下结构:
|
||||
|
||||
```
|
||||
~/.openfang/
|
||||
~/.zclaw/
|
||||
├── config.toml # 主配置文件
|
||||
├── openfang.db # SQLite 数据库
|
||||
├── zclaw.db # SQLite 数据库
|
||||
├── data/ # 数据目录
|
||||
│ ├── agents/ # Agent 配置
|
||||
│ ├── skills/ # 自定义技能
|
||||
@@ -111,10 +111,10 @@ openfang init
|
||||
|
||||
### 2. 配置文件结构
|
||||
|
||||
编辑 `~/.openfang/config.toml`:
|
||||
编辑 `~/.zclaw/config.toml`:
|
||||
|
||||
```toml
|
||||
# OpenFang 主配置文件
|
||||
# ZCLAW 主配置文件
|
||||
|
||||
[general]
|
||||
# 默认语言
|
||||
@@ -122,7 +122,7 @@ language = "zh-CN"
|
||||
# 日志级别: trace, debug, info, warn, error
|
||||
log_level = "info"
|
||||
# 数据目录
|
||||
data_dir = "~/.openfang/data"
|
||||
data_dir = "~/.zclaw/data"
|
||||
|
||||
[model]
|
||||
# 默认模型提供商
|
||||
@@ -225,39 +225,39 @@ base_url = "https://api.minimax.chat/v1"
|
||||
#### 前台运行(调试用)
|
||||
|
||||
```bash
|
||||
openfang start
|
||||
zclaw start
|
||||
```
|
||||
|
||||
#### 后台守护进程
|
||||
|
||||
```bash
|
||||
# 启动守护进程
|
||||
openfang daemon start
|
||||
zclaw daemon start
|
||||
|
||||
# 查看状态
|
||||
openfang status
|
||||
zclaw status
|
||||
|
||||
# 停止守护进程
|
||||
openfang daemon stop
|
||||
zclaw daemon stop
|
||||
```
|
||||
|
||||
#### 检查健康状态
|
||||
|
||||
```bash
|
||||
openfang doctor
|
||||
zclaw doctor
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 与 ZCLAW 集成
|
||||
|
||||
### 配置 ZCLAW 连接 OpenFang
|
||||
### 配置 ZCLAW 连接 ZCLAW
|
||||
|
||||
编辑 ZCLAW 配置文件 `~/.zclaw/config.toml`:
|
||||
|
||||
```toml
|
||||
[gateway]
|
||||
# OpenFang API 端点
|
||||
# ZCLAW API 端点
|
||||
endpoint = "http://127.0.0.1:50051"
|
||||
# WebSocket 端点
|
||||
ws_endpoint = "ws://127.0.0.1:50051/ws"
|
||||
@@ -265,15 +265,15 @@ ws_endpoint = "ws://127.0.0.1:50051/ws"
|
||||
timeout = 30
|
||||
|
||||
[model]
|
||||
# 使用 OpenFang 的模型路由
|
||||
# 使用 ZCLAW 的模型路由
|
||||
use_gateway_routing = true
|
||||
```
|
||||
|
||||
### 验证连接
|
||||
|
||||
```bash
|
||||
# 启动 OpenFang
|
||||
openfang start
|
||||
# 启动 ZCLAW
|
||||
zclaw start
|
||||
|
||||
# 在另一个终端启动 ZCLAW
|
||||
cd desktop && pnpm tauri dev
|
||||
@@ -360,19 +360,19 @@ chcp 65001
|
||||
export LANG=zh_CN.UTF-8
|
||||
```
|
||||
|
||||
### 6. 从 OpenClaw 迁移
|
||||
### 6. 从 ZCLAW 迁移
|
||||
|
||||
如果你之前使用 OpenClaw,可以使用迁移工具:
|
||||
如果你之前使用 ZCLAW,可以使用迁移工具:
|
||||
|
||||
```bash
|
||||
# 迁移所有内容:代理、记忆、技能、配置
|
||||
openfang migrate --from openclaw
|
||||
zclaw migrate --from zclaw
|
||||
|
||||
# 从特定路径迁移
|
||||
openfang migrate --from openclaw --path ~/.openclaw
|
||||
zclaw migrate --from zclaw --path ~/.zclaw
|
||||
|
||||
# 先试运行查看变更
|
||||
openfang migrate --from openclaw --dry-run
|
||||
zclaw migrate --from zclaw --dry-run
|
||||
```
|
||||
|
||||
---
|
||||
@@ -381,10 +381,10 @@ openfang migrate --from openclaw --dry-run
|
||||
|
||||
### 配置 Hands
|
||||
|
||||
Hands 是 OpenFang 的核心创新,每个 Hand 是一个预构建的自主能力包:
|
||||
Hands 是 ZCLAW 的核心创新,每个 Hand 是一个预构建的自主能力包:
|
||||
|
||||
```toml
|
||||
# ~/.openfang/data/hands/researcher.toml
|
||||
# ~/.zclaw/data/hands/researcher.toml
|
||||
|
||||
[hand]
|
||||
name = "researcher"
|
||||
@@ -409,7 +409,7 @@ citation_style = "apa"
|
||||
### 配置 MCP 服务器
|
||||
|
||||
```toml
|
||||
# ~/.openfang/config.toml
|
||||
# ~/.zclaw/config.toml
|
||||
|
||||
[[mcp_servers]]
|
||||
name = "filesystem"
|
||||
@@ -425,7 +425,7 @@ env = { DATABASE_URL = "postgresql://localhost/mydb" }
|
||||
### 配置渠道适配器
|
||||
|
||||
```toml
|
||||
# ~/.openfang/config.toml
|
||||
# ~/.zclaw/config.toml
|
||||
|
||||
[[channels]]
|
||||
type = "feishu"
|
||||
@@ -474,34 +474,34 @@ max_iterations = 50
|
||||
|
||||
```bash
|
||||
# 实时日志
|
||||
openfang logs -f
|
||||
zclaw logs -f
|
||||
|
||||
# 按级别过滤
|
||||
openfang logs --level error
|
||||
zclaw logs --level error
|
||||
|
||||
# 按时间范围
|
||||
openfang logs --since "2024-01-01" --until "2024-01-02"
|
||||
zclaw logs --since "2024-01-01" --until "2024-01-02"
|
||||
```
|
||||
|
||||
### 监控指标
|
||||
|
||||
```bash
|
||||
# 系统状态
|
||||
openfang status
|
||||
zclaw status
|
||||
|
||||
# 详细健康检查
|
||||
openfang doctor --verbose
|
||||
zclaw doctor --verbose
|
||||
|
||||
# 使用统计
|
||||
openfang usage --daily
|
||||
zclaw usage --daily
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相关链接
|
||||
|
||||
- [OpenFang 官方文档](https://openfang.sh/)
|
||||
- [GitHub 仓库](https://github.com/RightNow-AI/openfang)
|
||||
- [ZCLAW 官方文档](https://zclaw.sh/)
|
||||
- [GitHub 仓库](https://github.com/RightNow-AI/zclaw)
|
||||
- [中文模型配置](./chinese-models.md)
|
||||
- [ZCLAW 主文档](../../README.md)
|
||||
|
||||
@@ -509,6 +509,6 @@ openfang usage --daily
|
||||
|
||||
## 获取帮助
|
||||
|
||||
- **命令行帮助**:`openfang --help` 或 `openfang <command> --help`
|
||||
- **GitHub Issues**:https://github.com/RightNow-AI/openfang/issues
|
||||
- **命令行帮助**:`zclaw --help` 或 `zclaw <command> --help`
|
||||
- **GitHub Issues**:https://github.com/RightNow-AI/zclaw/issues
|
||||
- **社区讨论**:https://deepseek.club/t/topic/996
|
||||
|
||||
Reference in New Issue
Block a user