Files
clawpanel/README.md

503 lines
19 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<p align="center">
<img src="public/images/logo-brand.png" width="360" alt="ClawPanel">
</p>
<p align="center">
内置 AI 助手的 OpenClaw 管理面板 — 一键安装、配置、诊断、修复
</p>
<p align="center">
<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/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>
---
<p align="center">
<img src="docs/feature-showcase.gif" width="800" alt="ClawPanel 功能全景">
</p>
<p align="center">
<a href="https://claw.qt.cool/#video">
<img src="https://img.shields.io/badge/%E2%96%B6%20%E6%BC%94%E7%A4%BA%E8%A7%86%E9%A2%91-50%E7%A7%92%E5%BF%AB%E9%80%9F%E4%BA%86%E8%A7%A3-6366f1?style=for-the-badge" alt="演示视频">
</a>
</p>
ClawPanel 是 [OpenClaw](https://github.com/1186258278/OpenClawChineseTranslation) AI Agent 框架的可视化管理面板。**内置智能 AI 助手**,帮你一键安装 OpenClaw、自动诊断配置、排查问题、修复错误。8 大工具 + 4 种模式 + 交互式问答,从新手到老手都能轻松管理。
> 🌐 **官网**: [claw.qt.cool](https://claw.qt.cool/)  |  📦 **下载**: [GitHub Releases](https://github.com/qingchencloud/clawpanel/releases/latest)
## 社区交流
一群对 AI Agent 充满热情的开发者和玩家,欢迎加入交流。
<table align="center">
<tr>
<td align="center">
<a href="https://qt.cool/c/OpenClaw"><img src="docs/qr-qq.png" width="140" alt="QQ 群二维码"></a><br>
<a href="https://qt.cool/c/OpenClaw"><strong>QQ 群</strong></a>
</td>
<td align="center">
<a href="https://qt.cool/c/OpenClawWx"><img src="docs/qr-wechat.png" width="140" alt="微信群二维码"></a><br>
<a href="https://qt.cool/c/OpenClawWx"><strong>微信群</strong></a>
</td>
<td align="center">
<a href="https://qt.cool/c/OpenClawDY"><img src="docs/qr-dy.png" width="140" alt="抖音群二维码"></a><br>
<a href="https://qt.cool/c/OpenClawDY"><strong>抖音群</strong></a>
</td>
<td align="center">
<a href="https://qt.cool/c/feishu"><img src="https://qt.cool/c/feishu/qr.png" width="140" alt="飞书群二维码"></a><br>
<a href="https://qt.cool/c/feishu"><strong>飞书群</strong></a>
</td>
</tr>
</table>
<p align="center">
<a href="https://discord.gg/U9AttmsNHh"><strong>Discord</strong></a>
&nbsp;·&nbsp;
<a href="https://yb.tencent.com/gp/i/LsvIw7mdR7Lb"><strong>元宝派</strong></a>
&nbsp;·&nbsp;
<a href="https://github.com/qingchencloud/clawpanel/discussions"><strong>Discussions</strong></a>
&nbsp;·&nbsp;
<a href="https://github.com/qingchencloud/clawpanel/issues/new"><strong>反馈 Issue</strong></a>
&nbsp;·&nbsp;
<a href="https://qt.cool/c/feishu"><strong>飞书群</strong></a>
</p>
## 下载安装
前往 [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 拖入「应用程序」文件夹**,再双击打开。
> **⚠️ 首次打开提示"已损坏"或"无法验证开发者"** 由于应用未签名macOS 会拦截。请在终端执行以下命令解除限制:
>
> ```bash
> sudo xattr -rd com.apple.quarantine /Applications/ClawPanel.app
> ```
>
> 或者前往「系统设置 → 隐私与安全性」,找到 ClawPanel 点击「仍要打开」。
>
> 提示 `No such file`?说明没有拖入应用程序文件夹。请先拖入,或改用:
> ```bash
> sudo xattr -rd com.apple.quarantine ~/Downloads/ClawPanel.app
> ```
### 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` |
### Linux 服务器Web 版)
没有桌面环境?一键部署 ClawPanel Web 版,通过浏览器远程管理 OpenClaw
```bash
curl -fsSL https://raw.githubusercontent.com/qingchencloud/clawpanel/main/scripts/linux-deploy.sh | bash
```
部署完成后访问 `http://服务器IP:1420`,功能与桌面版一致。
📖 详细教程见 [Linux 部署指南](docs/linux-deploy.md)
### Docker 部署
```bash
docker run -d --name clawpanel --restart unless-stopped \
-p 1420:1420 -v clawpanel-data:/root/.openclaw \
node:22-slim \
sh -c "apt-get update && apt-get install -y git && \
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com && \
git clone https://github.com/qingchencloud/clawpanel.git /app && \
cd /app && npm install && npm run build && npm run serve"
```
📖 详细教程见 [Docker 部署指南](docs/docker-deploy.md)(含 Compose、自定义镜像、Nginx 反向代理等)
## 功能特性
<p align="center">
<img src="docs/feature-showcase.gif" width="800" alt="功能矩阵">
</p>
- **🤖 AI 助手(全新·重磅)** — 内置独立 AI 助手4 种操作模式 + 8 大工具 + 交互式问答,详见下方 [AI 助手亮点](#-ai-助手亮点)
- **🖼️ 图片识别** — 粘贴截图或拖拽图片AI 自动识别分析,支持多模态图文混排对话
- **仪表盘** — 系统概览,服务状态实时监控,快捷操作
- **服务管理** — OpenClaw 启停控制、版本检测与一键升级、Gateway 安装/卸载、配置备份与还原
- **模型配置** — 多服务商管理、模型增删改查、批量连通性测试、延迟检测、拖拽排序、自动保存+撤销
- **网关配置** — 端口、运行模式(本地/云端)、访问权限(本机/局域网)、认证 Token、Tailscale 组网
- **消息渠道** — 统一管理 Telegram、Discord 等外部消息接入,内置 QQ 机器人配置与凭证校验
- **Agent 管理** — Agent 增删改查、身份编辑、模型配置、工作区管理
- **聊天** — 流式响应、Markdown 渲染、会话管理、Agent 选择、快捷指令
- **日志查看** — 多日志源实时查看与关键词搜索
- **记忆管理** — 记忆文件查看/编辑、分类管理、ZIP 导出、Agent 切换
- **扩展工具** — cftunnel 内网穿透管理、ClawApp 状态监控
- **关于** — 版本信息、社群入口、相关项目链接、一键升级
## 功能截图
<p align="center">
<img src="docs/quick-stats.gif" width="800" alt="ClawPanel 数据概览">
</p>
<p align="center">
<img src="docs/01.png" width="800" alt="AI 助手">
</p>
<p align="center"><em>🤖 AI 助手 — 8 大技能卡片一键触发配置检查、Gateway 诊断、环境检测、一键排障等常用操作</em></p>
<p align="center">
<img src="docs/00.png" width="800" alt="仪表盘">
</p>
<p align="center"><em>仪表盘 — Gateway / 隧道 / 服务实时状态版本信息、Agent 数量、模型池一屏掌握</em></p>
<p align="center">
<img src="docs/02.png" width="800" alt="AI 助手设置 — 公益 AI 接口">
</p>
<p align="center"><em>⚙️ AI 设置 — 独立模型配置 + 公益 AI 接口一键接入GPT-5 全系列免费可用</em></p>
<p align="center">
<img src="docs/05.png" width="800" alt="AI 助手人设 — Agent 灵魂">
</p>
<p align="center"><em><3E> 借尸还魂 — 从 OpenClaw Agent 加载灵魂SOUL / IDENTITY / USER / AGENTS / TOOLS继承人格与记忆</em></p>
<p align="center">
<img src="docs/07.png" width="800" alt="实时聊天">
</p>
<p align="center"><em>实时聊天 — WebSocket 流式对话,多 Provider 模型自动聚合,支持多模态</em></p>
<p align="center">
<img src="docs/09.png" width="800" alt="模型配置">
</p>
<p align="center"><em>模型配置 — 多服务商统一管理,公益接口一键添加全部模型,主模型+备选自动切换</em></p>
<p align="center">
<img src="docs/13.png" width="800" alt="记忆文件">
</p>
<p align="center"><em>记忆文件 — 工作记忆、记忆归档、核心文件在线编辑,多 Agent 记忆隔离</em></p>
<details>
<summary><strong>查看更多截图</strong></summary>
<p align="center">
<img src="docs/10.png" width="800" alt="Agent 管理">
</p>
<p align="center"><em>Agent 管理 — 多 Agent 创建、身份配置与独立工作区管理</em></p>
<p align="center">
<img src="docs/11.png" width="800" alt="Gateway 安全认证">
</p>
<p align="center"><em>Gateway — Token / 密码双认证Agent 工具权限三档管控,会话可见性控制</em></p>
<p align="center">
<img src="docs/03.png" width="800" alt="服务管理">
</p>
<p align="center"><em>服务管理 — 启停控制、版本检测、一键升级、npm 源切换、配置备份</em></p>
<p align="center">
<img src="docs/12.png" width="800" alt="安全设置">
</p>
<p align="center"><em>安全设置 — 访问密码保护与无视风险模式</em></p>
<p align="center">
<img src="docs/14.png" width="800" alt="扩展工具">
</p>
<p align="center"><em>扩展工具 — cftunnel 内网穿透、ClawApp 移动客户端一键安装</em></p>
<p align="center">
<img src="docs/15.png" width="800" alt="系统诊断">
</p>
<p align="center"><em>系统诊断 — 全面健康检测、WebSocket 测试、一键修复配对</em></p>
<p align="center">
<img src="docs/16.png" width="800" alt="关于">
</p>
<p align="center"><em>关于 — 版本信息、社群入口QQ / 微信 / 抖音)、相关项目链接</em></p>
</details>
## 🤖 AI 助手亮点
ClawPanel 内置的 AI 助手不只是聊天机器人——它能**直接操作你的系统**,帮你诊断、修复、甚至提交 PR。
### 四种操作模式
一键切换,界面颜色随模式变化,清晰感知当前权限状态:
| 模式 | 图标 | 工具 | 写文件 | 确认 | 适用场景 |
|------|------|------|--------|------|---------|
| **聊天** | 💬 | ❌ | ❌ | — | 纯问答,不触碰系统 |
| **规划** | 📋 | ✅ | ❌ | ✅ | 读配置/查日志,输出方案不动文件 |
| **执行** | ⚡ | ✅ | ✅ | ✅ | 正常干活,危险操作弹确认 |
| **无限** | ∞ | ✅ | ✅ | ❌ | 全自动,工具调用不弹窗 |
设置中还有**工具开关**(终端/文件),优先级高于模式——关掉终端,即使无限模式也调不了命令。
### 八大工具
| 工具 | 功能 | 示例 |
|------|------|------|
| `ask_user` | 向用户提问(单选/多选/文本) | "选择要提交到哪个仓库?" |
| `get_system_info` | 获取 OS、架构、主目录 | 自动判断该用 PowerShell 还是 Bash |
| `run_command` | 执行 Shell 命令 | 重启 Gateway、查看日志 |
| `read_file` | 读取文件 | 读取 openclaw.json 分析配置 |
| `write_file` | 写入文件 | 修复配置错误、生成脚本 |
| `list_directory` | 浏览目录 | 列出 .openclaw/ 结构 |
| `list_processes` | 查看进程 | 检查 Gateway 是否在运行 |
| `check_port` | 检测端口占用 | 18789 端口被谁占了? |
### 交互式问答ask_user
AI 可以通过 `ask_user` 工具向你提问,支持三种交互方式:
- **单选** — 从多个方案中选一个,还能输入自定义答案
- **多选** — 勾选多项,比如"选择要检查的组件"
- **文本** — 自由输入,比如"描述你遇到的问题"
AI 等你回答后才会继续操作,实现真正的**人机协作**。
### PR 助手 & Bug 报告
发现 BugAI 不只是告诉你怎么修——它**直接帮你修**
1. 🐛 **提交 Bug 报告** — AI 自动收集系统环境、读取错误日志,按标准模板整理成 GitHub Issue你复制粘贴就能提交
2. 🔀 **PR 助手** — AI 分析 Bug 根因 → 定位代码 → 生成修复方案 → 通过 `run_command` 执行 git 命令完成 Fork/Branch/Commit/Push**用户只需点确认**
### 内置技能卡片
欢迎页提供一键触发的常用技能:
| 技能 | 功能 |
|------|------|
| 🔧 检查配置 | 读取并分析 openclaw.json |
| 🏥 诊断 Gateway | 检查进程、端口、日志 |
| 📂 浏览目录 | 查看 .openclaw 目录结构 |
| 💻 检查环境 | Node.js、npm 版本检测 |
| 📋 分析日志 | 搜索 ERROR/WARN 关键词 |
| 🔨 一键排障 | 自动检测并修复常见问题 |
| 🐛 提交 Bug | 整理 Issue 提交到 GitHub |
| 🔀 PR 助手 | 定位 Bug 并生成修复 PR |
## 技术架构
| 层级 | 技术 | 说明 |
|------|------|------|
| 前端 | Vanilla JS + Vite | 零框架依赖,轻量快速 |
| 后端 | Rust + Tauri v2 | 原生性能,跨平台打包 |
| 通信 | Tauri IPC + Shell Plugin | 前后端桥接,本地命令执行 |
| 样式 | 纯 CSSCSS Variables | 暗色/亮色主题,玻璃拟态风格 |
```
clawpanel/
├── src/ # 前端源码
│ ├── pages/ # 10 个页面模块
│ ├── components/ # 通用组件侧边栏、弹窗、Toast
│ ├── lib/ # 工具库Tauri API 封装、主题)
│ ├── style/ # 样式文件
│ ├── router.js # 路由
│ └── main.js # 入口
├── src-tauri/ # Rust 后端
│ ├── src/ # Tauri 命令与业务逻辑
│ ├── Cargo.toml # Rust 依赖
│ └── tauri.conf.json # Tauri 配置
├── public/ # 静态资源
├── scripts/ # 开发与构建脚本
│ ├── dev.sh # 开发模式启动
│ └── build.sh # 编译与打包
├── .github/workflows/ # CI/CD
│ ├── ci.yml # 持续集成push/PR 自动检查)
│ └── release.yml # 发布构建(全平台打包)
├── index.html # HTML 入口
├── vite.config.js # Vite 配置
└── package.json # 前端依赖
```
## 从源码构建
### 前置条件
- [Node.js](https://nodejs.org/) >= 18
- [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
```
#### macOS / Linux
```bash
# 启动完整 Tauri 桌面应用
./scripts/dev.sh
# 仅启动 Vite 前端(浏览器调试,使用 mock 数据)
./scripts/dev.sh web
```
#### Windows
```powershell
# 启动完整 Tauri 桌面应用
npm run tauri dev
# 仅启动 Vite 前端(浏览器调试,使用 mock 数据)
npm run dev
```
### 构建
#### macOS / Linux
```bash
# 编译 debug 版本
./scripts/build.sh
# 仅检查 Rust 编译(最快,不生成产物)
./scripts/build.sh check
# 编译正式发布版本(含打包)
./scripts/build.sh release
```
#### Windows
```powershell
# 检查 Rust 编译
cd src-tauri && cargo check
# 编译正式发布版本
npm run tauri build
# 指定打包格式NSIS 安装器)
npm run tauri build -- --bundles nsis
```
产物位于 `src-tauri/target/release/` 目录。
## 常见问题
### macOS 提示"已损坏,无法打开"
没有苹果开发者签名macOS Gatekeeper 会拦截。终端执行:
```bash
sudo xattr -rd com.apple.quarantine /Applications/ClawPanel.app
```
或前往「系统设置 → 隐私与安全性」点击「仍要打开」。
### macOS 检测不到 Node.js
从 Finder/Dock 启动 ClawPanel 时,应用的 PATH 环境变量可能不包含 Node.js 安装路径。
**v0.4.1 已修复**:自动补充 `/usr/local/bin``/opt/homebrew/bin``~/.nvm``~/.volta` 等常见路径。
临时解决:从终端启动 ClawPanel
```bash
open /Applications/ClawPanel.app
```
### Windows 安装 OpenClaw 报 ENOENT (-4058)
通常是文件权限或 npm 缓存问题:
1. 以管理员身份运行 ClawPanel
2. 或打开 PowerShell管理员手动安装
```powershell
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com
```
3. 如果仍报错,清理 npm 缓存:`npm cache clean --force`
### Windows 安装报 exit 128 (access rights)
npm 依赖需要 Git。如果已装 Git 但仍报 128是因为依赖用了 SSH 协议拉代码但你没配 GitHub SSH Key。运行以下命令改用 HTTPS
```powershell
git config --global url."https://github.com/".insteadOf ssh://git@github.com/
git config --global url."https://github.com/".insteadOf git@github.com:
```
没装 Git 的请先安装 [Git for Windows](https://git-scm.com/download/win)。**v0.4.2+ 已自动配置 HTTPS 模式。**
### Windows 安装报 EPERM (operation not permitted)
文件被其他进程锁定。先关闭 ClawPanel 和所有 Node.js 进程,以管理员身份打开 PowerShell 重装:
```powershell
npm cache clean --force
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com
```
### 安装后 Node.js 检测不到Windows
安装 Node.js 后需要**重启 ClawPanel**,新的 PATH 环境变量才能生效。
如果安装在非默认路径(如 `D:\nodejs`、`F:\AI\Node`),请确认该目录已加入系统 PATH 环境变量。**v0.4.2+ 已自动扫描常见安装路径。**
## 相关项目
| 项目 | 说明 |
|------|------|
| [OpenClaw](https://github.com/1186258278/OpenClawChineseTranslation) | AI Agent 框架 |
| [ClawApp](https://github.com/qingchencloud/clawapp) | 跨平台移动聊天客户端 |
| [cftunnel](https://github.com/qingchencloud/cftunnel) | Cloudflare Tunnel 内网穿透工具 |
## 赞助商
感谢以下赞助商对 ClawPanel 项目的支持:
<table align="center">
<tr>
<td align="center">
<a href="https://www.ciyundata.com/cart/goods.htm?id=267" target="_blank">
<img src="https://img.shields.io/badge/慈云数据-香港直连2H2G_99元/年-FF6B35?style=for-the-badge&logo=icloud&logoColor=white" alt="慈云数据">
</a>
<br><br>
<sub>慈云数据服务团队于 2020 年成立,专注于基础云计算、游戏云、主题站长等业务</sub>
<br>
<sub>售前售后服务 24 小时在线值班,强力保证为客户提供优质稳定的网络资源与机房服务</sub>
</td>
</tr>
</table>
## 贡献
欢迎提交 Issue 和 Pull Request。贡献流程详见 [CONTRIBUTING.md](CONTRIBUTING.md)。
## 许可证
[MIT License](LICENSE)