Skip to content

Commit bef7ecd

Browse files
Ericonaldoclaude
andcommitted
docs: add 3 focused demo GIFs, table of contents, and sync Chinese README
- Replace single demo.gif with 3 focused demo recordings: - demo-quickstart.gif: create agent with CLAUDE.md template → run → complete - demo-chat-terminal.gif: chat interaction → PTY terminal → clone agent - demo-pipeline.gif: Agent Manager pipeline → sequential task execution - Add Table of Contents to both README.md and README-zh.md - Sync Chinese README: add clone tip, terminal Socket.IO events, TerminalService entry Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent d327b39 commit bef7ecd

5 files changed

Lines changed: 69 additions & 4 deletions

File tree

‎README-zh.md‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,23 @@
1515

1616
---
1717

18+
## 目录
19+
20+
- [核心功能](#核心功能)
21+
- [演示](#演示)
22+
- [截图](#截图)
23+
- [快速开始](#快速开始)
24+
- [配置](#配置)
25+
- [使用方法](#使用方法)
26+
- [API 参考](#api-参考)
27+
- [远程访问(中继模式)](#远程访问中继模式)
28+
- [提供者支持](#提供者支持)
29+
- [测试](#测试)
30+
- [架构](#架构)
31+
- [许可证](#许可证)
32+
33+
---
34+
1835
## 核心功能
1936

2037
### 多代理编排
@@ -80,9 +97,20 @@
8097

8198
## 演示
8299

83-
![Agent Monitor 演示](docs/screenshots/demo.gif)
100+
### 快速开始 — 使用模板创建代理
101+
![快速开始演示](docs/screenshots/demo-quickstart.gif)
102+
103+
*使用 CLAUDE.md 模板创建代理 → 代理自主运行 → 任务完成*
104+
105+
### 对话 & 终端
106+
![对话与终端演示](docs/screenshots/demo-chat-terminal.gif)
84107

85-
*完整工作流:创建带 CLAUDE.md 模板的代理 → 完成任务 → 交互式对话 → PTY 终端 → 克隆代理 → 任务流水线*
108+
*交互式对话 → 代理调用工具执行任务 → PTY 终端 → 克隆代理*
109+
110+
### 任务流水线
111+
![流水线演示](docs/screenshots/demo-pipeline.gif)
112+
113+
*代理管理器:添加任务 → 启动管理器 → 观察代理顺序执行*
86114

87115
---
88116

@@ -205,6 +233,8 @@ npm run dev # 同时启动服务端(tsx watch)+ 客户端(vite dev)
205233
7. 输入 **管理员邮箱**、**WhatsApp 手机号** 和/或 **Slack Webhook URL** 用于通知
206234
8. 点击 **创建代理**
207235

236+
**提示 —— 克隆现有代理:** 点击任意代理卡片上的 **克隆** 按钮,即可创建一个预填了相同目录、提供者、参数和 CLAUDE.md 的新代理。配合模板可打造可复用的代理库:创建一个包含标准指令的模板 → 使用该模板创建一个代理 → 每次需要新实例时克隆即可。
237+
208238
### 仪表盘
209239

210240
每个代理以丰富信息卡片形式显示,包含:
@@ -304,6 +334,12 @@ npm run dev # 同时启动服务端(tsx watch)+ 客户端(vite dev)
304334
| `agent:status` | 服务端 → 客户端 | 状态变更 |
305335
| `task:update` | 服务端 → 客户端 | 流水线任务更新 |
306336
| `pipeline:complete` | 服务端 → 客户端 | 流水线完成 |
337+
| `terminal:open` | 客户端 → 服务端 | 在代理目录中打开 PTY 终端 |
338+
| `terminal:input` | 客户端 → 服务端 | 向 PTY 发送按键输入 |
339+
| `terminal:resize` | 客户端 → 服务端 | 调整 PTY 尺寸 |
340+
| `terminal:close` | 客户端 → 服务端 | 关闭 PTY 会话 |
341+
| `terminal:output` | 服务端 → 客户端 | PTY 输出数据 |
342+
| `terminal:exit` | 服务端 → 客户端 | PTY 进程退出 |
307343
| `meta:status` | 服务端 → 客户端 | Meta Agent 状态 |
308344

309345
---
@@ -364,6 +400,7 @@ AgentMonitor/
364400
MetaAgentManager.ts # 流水线编排
365401
TunnelClient.ts # 到中继服务器的出站隧道
366402
tunnelBridge.ts # 隧道事件桥接
403+
TerminalService.ts # PTY 终端管理(node-pty)
367404
WorktreeManager.ts # Git worktree 操作
368405
EmailNotifier.ts # SMTP 邮件通知
369406
WhatsAppNotifier.ts # Twilio WhatsApp 通知

‎README.md‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,23 @@ A web dashboard to run, monitor, and manage **Claude Code** and **Codex** agents
1515

1616
---
1717

18+
## Table of Contents
19+
20+
- [Key Features](#key-features)
21+
- [Demo](#demo)
22+
- [Screenshots](#screenshots)
23+
- [Quick Start](#quick-start)
24+
- [Configuration](#configuration)
25+
- [Usage](#usage)
26+
- [API Reference](#api-reference)
27+
- [Remote Access (Relay Mode)](#remote-access-relay-mode)
28+
- [Provider Support](#provider-support)
29+
- [Testing](#testing)
30+
- [Architecture](#architecture)
31+
- [License](#license)
32+
33+
---
34+
1835
## Key Features
1936

2037
### Multi-Agent Orchestration
@@ -80,9 +97,20 @@ Phone / Laptop ──HTTP──▶ Public Server (Relay :3457) ◀──WS tunne
8097

8198
## Demo
8299

83-
![Agent Monitor Demo](docs/screenshots/demo.gif)
100+
### Quick Start — Create Agent with Template
101+
![Quick Start Demo](docs/screenshots/demo-quickstart.gif)
102+
103+
*Create agent with CLAUDE.md template → agent runs autonomously → task completes*
104+
105+
### Chat & Terminal
106+
![Chat & Terminal Demo](docs/screenshots/demo-chat-terminal.gif)
107+
108+
*Interactive chat → agent responds with tool calls → PTY terminal → clone agent*
109+
110+
### Task Pipeline
111+
![Pipeline Demo](docs/screenshots/demo-pipeline.gif)
84112

85-
*Full workflow: create agent with CLAUDE.md template → complete task → interactive chat → PTY terminal → clone agent → task pipeline*
113+
*Agent Manager: add tasks → start manager → watch agents run sequentially*
86114

87115
---
88116

969 KB
Loading

‎docs/screenshots/demo-pipeline.gif‎

3.1 MB
Loading
1.83 MB
Loading

0 commit comments

Comments
 (0)