mirror of
https://github.com/qingchencloud/clawpanel.git
synced 2026-05-06 20:02:49 +08:00
docs: 完善项目文档与 Release 下载引导
- README: 新增下载安装区(macOS/Windows/Linux 分系统引导)、补充功能特性(10 个页面模块)、更新目录结构 - CHANGELOG: 重写 v0.1.0 变更记录,按 Keep a Changelog 格式详列所有功能 - release.yml: 动态生成 Release Body(含版本化下载引导表 + git log 自动 changelog),fetch-depth: 0 拉全量历史 - 已同步更新 v0.1.0 Release 页面描述
This commit is contained in:
89
README.md
89
README.md
@@ -9,33 +9,71 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/qingchencloud/clawpanel/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
|
||||
<a href="https://github.com/qingchencloud/clawpanel/releases/latest">
|
||||
<img src="https://img.shields.io/github/v/release/qingchencloud/clawpanel?style=flat-square&color=6366f1" alt="Release">
|
||||
</a>
|
||||
<a href="https://github.com/qingchencloud/clawpanel/releases">
|
||||
<img src="https://img.shields.io/github/v/release/qingchencloud/clawpanel" alt="Release">
|
||||
<a href="https://github.com/qingchencloud/clawpanel/releases/latest">
|
||||
<img src="https://img.shields.io/github/downloads/qingchencloud/clawpanel/total?style=flat-square&color=8b5cf6" alt="Downloads">
|
||||
</a>
|
||||
<a href="https://github.com/qingchencloud/clawpanel/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="License">
|
||||
</a>
|
||||
<a href="https://github.com/qingchencloud/clawpanel/actions/workflows/ci.yml">
|
||||
<img src="https://img.shields.io/github/actions/workflow/status/qingchencloud/clawpanel/ci.yml?style=flat-square&label=CI" alt="CI">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
ClawPanel 是 [OpenClaw](https://github.com/openclaw-labs/openclaw) AI Agent 框架的可视化管理面板,提供服务管控、模型配置、日志查看、记忆管理等核心功能,一站式管理 OpenClaw 实例。
|
||||
ClawPanel 是 [OpenClaw](https://github.com/openclaw-labs/openclaw) AI Agent 框架的可视化管理面板,提供服务管控、模型配置、日志查看、记忆管理等核心功能,一站式管理你的 OpenClaw 实例。
|
||||
|
||||
## 下载安装
|
||||
|
||||
前往 [Releases](https://github.com/qingchencloud/clawpanel/releases/latest) 页面下载最新版本,根据你的系统选择对应安装包:
|
||||
|
||||
### macOS
|
||||
|
||||
| 芯片 | 安装包 | 说明 |
|
||||
|------|--------|------|
|
||||
| Apple Silicon (M1/M2/M3/M4) | `ClawPanel_x.x.x_aarch64.dmg` | 2020 年末及之后的 Mac |
|
||||
| Intel | `ClawPanel_x.x.x_x64.dmg` | 2020 年及之前的 Mac |
|
||||
|
||||
> 不确定芯片类型?点击左上角 → 关于本机,查看「芯片」一栏。
|
||||
|
||||
安装方式:打开 `.dmg` 文件,将 ClawPanel 拖入「应用程序」文件夹。首次打开如遇安全提示,前往「系统设置 → 隐私与安全性」点击「仍要打开」。
|
||||
|
||||
### Windows
|
||||
|
||||
| 格式 | 安装包 | 说明 |
|
||||
|------|--------|------|
|
||||
| EXE 安装器 | `ClawPanel_x.x.x_x64-setup.exe` | 推荐,双击安装 |
|
||||
| MSI 安装器 | `ClawPanel_x.x.x_x64_en-US.msi` | 企业部署 / 静默安装 |
|
||||
|
||||
### Linux
|
||||
|
||||
| 格式 | 安装包 | 说明 |
|
||||
|------|--------|------|
|
||||
| AppImage | `ClawPanel_x.x.x_amd64.AppImage` | 免安装,`chmod +x` 后直接运行 |
|
||||
| DEB | `ClawPanel_x.x.x_amd64.deb` | Debian / Ubuntu:`sudo dpkg -i *.deb` |
|
||||
| RPM | `ClawPanel-x.x.x-1.x86_64.rpm` | Fedora / RHEL:`sudo rpm -i *.rpm` |
|
||||
|
||||
## 功能特性
|
||||
|
||||
- **仪表盘** — 系统概览,服务状态实时监控,快捷操作
|
||||
- **服务管理** — OpenClaw 启停控制、版本检测与一键升级、Gateway 安装/卸载、配置备份与还原
|
||||
- **模型配置** — 多服务商管理、模型增删改查、批量连通性测试、延迟检测、拖拽排序、自动保存+撤销
|
||||
- **网关配置** — 端口、运行模式(本地/云端)、访问权限(本机/局域网)、认证 Token、Tailscale 组网
|
||||
- **Agent 管理** — Agent 增删改查、身份编辑、模型配置、工作区管理
|
||||
- **聊天** — 流式响应、Markdown 渲染、会话管理、Agent 选择、快捷指令
|
||||
- **日志查看** — 多日志源实时查看与关键词搜索
|
||||
- **记忆管理** — 记忆文件查看/编辑、分类管理、ZIP 导出、Agent 切换
|
||||
- **扩展工具** — cftunnel 内网穿透管理、ClawApp 状态监控
|
||||
- **关于** — 版本信息、社群入口、相关项目链接、一键升级
|
||||
|
||||
## 功能截图
|
||||
|
||||
> 截图待补充
|
||||
|
||||
## 功能特性
|
||||
|
||||
- **仪表盘** — 系统概览,服务状态实时监控
|
||||
- **服务管理** — OpenClaw 服务状态监控与启停控制、版本检测、配置自动备份、备份状态查看与快速还原
|
||||
- **模型配置** — 多服务商管理、模型增删改查、支持快速验证网络连通性 (Model Test)、一键应用默认配置
|
||||
- **网关配置** — Gateway 端口配置、运行模式管理与认证相关设置项,支持自动重载
|
||||
- **日志查看** — 多日志源(OpenClaw 核心与 Gateway)实时查看与关键字搜索
|
||||
- **记忆管理** — OpenClaw 记忆文件系统的动态管理及内容预览,支持打包下载 (.zip) 或部分导出
|
||||
- **扩展工具** — Cloudflare Tunnel 内网穿透隧道管理 (cftunnel)、ClawApp 相关连接与状态检测
|
||||
- **关于** — 版本信息、核心组件与开源项目指引、社群与联系入口
|
||||
|
||||
## 技术架构
|
||||
|
||||
| 层级 | 技术 | 说明 |
|
||||
@@ -43,12 +81,12 @@ ClawPanel 是 [OpenClaw](https://github.com/openclaw-labs/openclaw) AI Agent 框
|
||||
| 前端 | Vanilla JS + Vite | 零框架依赖,轻量快速 |
|
||||
| 后端 | Rust + Tauri v2 | 原生性能,跨平台打包 |
|
||||
| 通信 | Tauri IPC + Shell Plugin | 前后端桥接,本地命令执行 |
|
||||
| 样式 | 纯 CSS(CSS Variables) | 暗色主题,玻璃拟态风格 |
|
||||
| 样式 | 纯 CSS(CSS Variables) | 暗色/亮色主题,玻璃拟态风格 |
|
||||
|
||||
```
|
||||
clawpanel/
|
||||
├── src/ # 前端源码
|
||||
│ ├── pages/ # 8 个页面模块
|
||||
│ ├── pages/ # 10 个页面模块
|
||||
│ ├── components/ # 通用组件(侧边栏、弹窗、Toast)
|
||||
│ ├── lib/ # 工具库(Tauri API 封装、主题)
|
||||
│ ├── style/ # 样式文件
|
||||
@@ -62,12 +100,15 @@ clawpanel/
|
||||
├── scripts/ # 开发与构建脚本
|
||||
│ ├── dev.sh # 开发模式启动
|
||||
│ └── build.sh # 编译与打包
|
||||
├── .github/workflows/ # CI/CD
|
||||
│ ├── ci.yml # 持续集成(push/PR 自动检查)
|
||||
│ └── release.yml # 发布构建(全平台打包)
|
||||
├── index.html # HTML 入口
|
||||
├── vite.config.js # Vite 配置
|
||||
└── package.json # 前端依赖
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
## 从源码构建
|
||||
|
||||
### 前置条件
|
||||
|
||||
@@ -75,18 +116,14 @@ clawpanel/
|
||||
- [Rust](https://www.rust-lang.org/tools/install) (stable)
|
||||
- Tauri v2 系统依赖(参考 [Tauri 官方文档](https://v2.tauri.app/start/prerequisites/))
|
||||
|
||||
### 安装依赖
|
||||
### 安装与开发
|
||||
|
||||
```bash
|
||||
git clone https://github.com/qingchencloud/clawpanel.git
|
||||
cd clawpanel
|
||||
npm install
|
||||
```
|
||||
|
||||
### 开发
|
||||
|
||||
```bash
|
||||
# 启动完整 Tauri 桌面应用(默认)
|
||||
# 启动完整 Tauri 桌面应用
|
||||
./scripts/dev.sh
|
||||
|
||||
# 仅启动 Vite 前端(浏览器调试,使用 mock 数据)
|
||||
@@ -96,7 +133,7 @@ npm install
|
||||
### 构建
|
||||
|
||||
```bash
|
||||
# 编译 debug 版本(默认)
|
||||
# 编译 debug 版本
|
||||
./scripts/build.sh
|
||||
|
||||
# 仅检查 Rust 编译(最快,不生成产物)
|
||||
|
||||
Reference in New Issue
Block a user