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:
晴天
2026-03-01 14:30:00 +08:00
parent 2a788e49e7
commit 25080cb1e5
3 changed files with 163 additions and 44 deletions

View File

@@ -49,6 +49,8 @@ jobs:
# 签出代码
- name: 签出代码
uses: actions/checkout@v4
with:
fetch-depth: 0
# 安装 Node.js 22
- name: 安装 Node.js
@@ -96,6 +98,66 @@ jobs:
echo "TAG_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
fi
# 生成 Release Body下载引导 + 动态 changelog
- name: 生成 Release Body
id: release_body
shell: bash
run: |
VERSION="${TAG_NAME#v}"
# 获取上一个 tag用于生成 changelog
PREV_TAG=$(git tag --sort=-v:refname | grep -E '^v' | sed -n '2p' || echo "")
# 动态生成 changelog
if [ -n "$PREV_TAG" ]; then
CHANGELOG=$(git log "${PREV_TAG}..HEAD" --pretty=format:"- %s" --no-merges | head -30)
CHANGELOG_HEADER="自 ${PREV_TAG} 以来的更新"
else
CHANGELOG=$(git log --pretty=format:"- %s" --no-merges -20)
CHANGELOG_HEADER="主要更新"
fi
# 写入 Release Body
cat > release_body.md << ENDOFBODY
## 下载安装
根据你的操作系统选择对应安装包:
### macOS
| 芯片 | 安装包 | 说明 |
|------|--------|------|
| Apple Silicon (M1/M2/M3/M4) | \`ClawPanel_${VERSION}_aarch64.dmg\` | 2020 年末及之后的 Mac |
| Intel | \`ClawPanel_${VERSION}_x64.dmg\` | 2020 年及之前的 Mac |
> 不确定芯片类型?点击左上角 → 关于本机,查看「芯片」一栏。
### Windows
| 格式 | 安装包 | 说明 |
|------|--------|------|
| EXE 安装器 | \`ClawPanel_${VERSION}_x64-setup.exe\` | 推荐,双击安装 |
| MSI 安装器 | \`ClawPanel_${VERSION}_x64_en-US.msi\` | 企业部署 / 静默安装 |
### Linux
| 格式 | 安装包 | 说明 |
|------|--------|------|
| AppImage | \`ClawPanel_${VERSION}_amd64.AppImage\` | 免安装,\`chmod +x\` 后直接运行 |
| DEB | \`ClawPanel_${VERSION}_amd64.deb\` | Debian / Ubuntu\`sudo dpkg -i *.deb\` |
| RPM | \`ClawPanel-${VERSION}-1.x86_64.rpm\` | Fedora / RHEL\`sudo rpm -i *.rpm\` |
---
## ${CHANGELOG_HEADER}
${CHANGELOG}
---
完整更新日志请查看 [CHANGELOG.md](https://github.com/qingchencloud/clawpanel/blob/main/CHANGELOG.md)
ENDOFBODY
# 去除 heredoc 缩进
sed -i.bak 's/^ //' release_body.md && rm -f release_body.md.bak
# 使用 tauri-action 构建并发布
- name: 构建 Tauri 应用
uses: tauri-apps/tauri-action@v0
@@ -104,7 +166,20 @@ jobs:
with:
tagName: ${{ env.TAG_NAME }}
releaseName: "ClawPanel ${{ env.TAG_NAME }}"
releaseBody: "详细变更记录请查看提交历史。"
releaseBody: "构建中,稍后更新..."
releaseDraft: false
prerelease: false
args: ${{ matrix.platform.args }}
# 更新 Release Body仅第一个完成的 job 执行)
- name: 更新 Release 描述
if: always()
shell: bash
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# 检查当前 Release body 是否为空或默认值,避免重复更新
CURRENT_BODY=$(gh release view "$TAG_NAME" --json body -q '.body' 2>/dev/null || echo "")
if [ ${#CURRENT_BODY} -lt 100 ]; then
gh release edit "$TAG_NAME" --notes-file release_body.md
fi

View File

@@ -5,23 +5,30 @@
格式遵循 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/)
版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
## [0.1.0] - 2026-02-28
## [0.1.0] - 2026-03-01
### 优化项 (Refactor & UI Improvements)
首个公开发布版本,包含 OpenClaw 管理面板的全部核心功能。
- 移除了由浏览器原生提供的阻塞级弹窗 (`alert``confirm``prompt`),以自定义风格化的 `Modal` 组件重写全站交互以兼容 Tauri WebView 限制。
- 采用更集约化的布局逻辑重构并合并部分低频页面,大幅精简前后端不必要的接口耦合。
- 当在终端更新网关与模型配置时,将自动重启 Gateway 以立即生效设定。
### 新增 (Features)
- 仪表盘:系统概览、服务状态一览
- 服务管理OpenClaw 服务启停、版本检测一键升级、Gateway 安装/卸载
- 模型配置:服务商管理、模型增删改查、主模型选择、批量测试延迟检测、自动保存+撤销
- 网关配置:端口、运行模式、认证 Token 配置
- 日志查看:多日志源实时查看、关键词搜索
- 记忆管理记忆文件查看、编辑、分类管理、ZIP 导出
- 扩展工具cftunnel 内网穿透管理、ClawApp 状态监控
- 关于页面:版本信息、社群二维码、相关项目链接
- 配置备份:手动创建/恢复/删除备份
- 暗色/亮色主题切换
- 服务商预设OpenAI/Anthropic/DeepSeek/Google
- 模型预设(常用模型一键添加)
- **仪表盘** — 6 张状态卡片Gateway、版本、Agent 舰队、模型池、隧道、基础服务)+ 系统概览面板 + 最近日志 + 快捷操作
- **服务管理** — OpenClaw 服务启停控制、版本检测一键升级(支持官方/汉化源切换)、Gateway 安装/卸载、npm 源配置(淘宝/官方/华为云)、配置备份管理(创建/恢复/删除)
- **模型配置** — 多服务商管理(支持 OpenAI/Anthropic/DeepSeek/Google 预设)、模型增删改查、主模型与 Fallback 选择、批量连通性测试延迟检测、拖拽排序、自动保存 + 撤销栈(最多 20 步)
- **网关配置** — 端口配置、运行模式(本地/云端)、访问权限(本机/局域网)、认证 Token、Tailscale 组网选项,保存后自动重载 Gateway
- **Agent 管理** — Agent 增删改查、身份编辑(名称/Emoji、模型配置、工作区管理、Agent 备份
- **聊天** — 流式响应、Markdown 渲染、会话管理、Agent 选择、快捷指令、WebSocket 连接
- **日志查看** — 多日志源Gateway/守护进程/审计日志)实时查看、关键词搜索、自动滚动
- **记忆管理** — 记忆文件查看/编辑、分类管理(工作记忆/归档/核心文件、ZIP 导出、Agent 切换
- **扩展工具** — cftunnel 内网穿透隧道管理(启停/日志/路由查看、ClawApp 守护进程状态监控、一键安装
- **关于页面** — 版本信息、社群二维码QQ/微信)、相关项目链接、一键升级入口
- **主题切换** — 暗色/亮色主题CSS Variables 驱动
- **自定义 Modal** — 全局替换浏览器原生弹窗alert/confirm/prompt兼容 Tauri WebView
- **CI/CD** — GitHub Actions 持续集成 + 全平台发布构建macOS ARM64/Intel、Windows x64、Linux x64
- **手动发布** — 支持 workflow_dispatch 手动触发构建,填入版本号即可一键发布
### 技术亮点
- 零框架依赖:纯 Vanilla JS无 React/Vue 等框架
- Tauri v2 + Rust 后端,原生性能
- 玻璃拟态暗色主题,现代化 UI
- 全中文界面与代码注释

View File

@@ -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 | 前后端桥接,本地命令执行 |
| 样式 | 纯 CSSCSS Variables | 暗色主题,玻璃拟态风格 |
| 样式 | 纯 CSSCSS 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 编译(最快,不生成产物)