mirror of
https://github.com/dtzp555-max/ocm.git
synced 2026-07-21 21:15:08 +00:00
Compare commits
14
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 
|
3d58bfc8af | ||
|
|
d3fdbcef6a | ||
|
|
16a080e0b2 | ||
|
|
69258d8428 | ||
|
|
a371ba6f7c | ||
|
|
8ae5fdb20c | ||
|
|
c3ed4c9c8f | ||
|
|
0a5f963b14 | ||
|
|
9e3ec7b616 | ||
|
|
55bfdcdbc8 | ||
|
|
c6da627fed | ||
|
|
743b8acea1 | ||
|
|
e0ebe68fb5 | ||
|
|
1c894d4ee7 |
@@ -1,10 +1,55 @@
|
||||
# OpenClaw Manager — 开发日志
|
||||
|
||||
> 最后更新：2026-02-28
|
||||
> 当前版本：v0.7.1
|
||||
> 最后更新：2026-03-17
|
||||
> 当前版本：v0.9.4
|
||||
|
||||
---
|
||||
|
||||
## v0.9.4 更新日志（2026-03-17）
|
||||
|
||||
### New Features
|
||||
|
||||
- **Skills & Tools 自动配置**：创建 Agent / Sub-Agent 时自动加载默认 Skills 和 Tool Groups
|
||||
- 默认 Skills：`memory-continuity`, `agent-workflow`, `execution-agent-dispatch`, `session-logs`
|
||||
- 默认 Tool Groups：`group:fs`, `group:runtime`, `group:memory`, `sessions_spawn`, `subagents`
|
||||
- 创建表单新增可折叠的 Skills & Tools 选择面板，支持 checkbox 多选
|
||||
- 提供「仅默认」「全选」「清空」快捷按钮
|
||||
- 不展开 / 不修改则自动使用默认预设，开箱即用
|
||||
- 支持的可选 Skills：browser-use, github, gh-issues, coding-agent, execution-agent-planner, discord, weather, summarize, healthcheck
|
||||
- 四个创建端点（Telegram Agent/Sub、Discord Agent/Sub）均支持 `skills` + `toolGroups` 字段
|
||||
|
||||
### Backend
|
||||
|
||||
- 新增 `applySkillsTools()` 服务端辅助函数，统一处理 skills/tools 的默认值回退逻辑
|
||||
- `POST /api/agents/bot`、`POST /api/agents/discord`、`POST /api/agents/discord-sub`、`POST /api/agents` 均已适配
|
||||
|
||||
### UI
|
||||
|
||||
- Skills & Tools Picker：深色风格 checkbox 网格，嵌入创建表单底部
|
||||
- 新增专用 CSS 样式（`.skills-picker`、`.sp-grid`、`.sp-item`、`.sp-actions`）
|
||||
- 新增 i18n 字符串支持中英文标签
|
||||
|
||||
---
|
||||
|
||||
## v0.9.0 更新日志（2026-03-01）
|
||||
|
||||
### New Features
|
||||
|
||||
- Agents: Add Agent / Add Sub-Agent 向导支持 Telegram + Discord
|
||||
- Telegram: 传统 group 绑定
|
||||
- Discord: 主 Agent 建议绑定 Channel；Sub-Agent 建议绑定 Thread
|
||||
- Routing: 删除绑定提示文案增强（支持“更换 group/thread → 先删旧绑定再加新绑定”）
|
||||
|
||||
### UX / UI
|
||||
|
||||
- 顶部居中显示醒目的 OCM 版本标识
|
||||
- Agents 页面：Agent Tree 支持显示 bindings 概览（Telegram/Discord）并按 parentAgentId 分组
|
||||
- Setup Guide：补全 Telegram Allow Groups 步骤；Discord guide 按 channel/thread 经验重写
|
||||
|
||||
### Fixes
|
||||
|
||||
- 修复 MAIN_HTML_SCRIPT 内联 JS 语法问题（tree toggle / i18n 单引号等），避免启动自检失败
|
||||
|
||||
## Unreleased（2026-02-28）
|
||||
|
||||
### Dashboard / Layout
|
||||
|
||||
@@ -1,40 +1,74 @@
|
||||
# OpenClaw Manager (OCM)
|
||||
|
||||
A zero-dependency, single-file web dashboard for [OpenClaw](https://github.com/anthropics/openclaw). Manage agents, monitor token usage, and run commands — all from your browser, no `npm install` required.
|
||||
A local control panel for [OpenClaw](https://github.com/anthropics/openclaw) that makes setup checks, agent management, health inspection, and recovery much easier — without living in JSON and terminal tabs all day.
|
||||
|
||||
[中文说明](#中文说明) · [中文使用说明（含截图）](docs/USAGE_GUIDE.zh-CN.md) · [English Guide (with screenshots)](docs/USAGE_GUIDE.en.md)
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
## Why OCM exists
|
||||
|
||||
```bash
|
||||
# Clone
|
||||
git clone https://github.com/dtzp555-max/ocm.git
|
||||
cd ocm
|
||||
Running OpenClaw directly is powerful, but the day-to-day workflow can get messy fast:
|
||||
|
||||
# Run (no npm install needed)
|
||||
bash start.sh # macOS / Linux
|
||||
start.bat # Windows
|
||||
- `openclaw.json` is easy to break by hand
|
||||
- agent / bot / channel bindings are hard to visualize
|
||||
- health checks, logs, restarts, and rollback are scattered across terminal commands
|
||||
- when something goes wrong, recovery is slower than it should be
|
||||
|
||||
# Update
|
||||
git pull --ff-only
|
||||
```
|
||||
OCM gives you a **local control panel** for the things that become painful first:
|
||||
- seeing your current setup clearly
|
||||
- operating it more safely
|
||||
- recovering faster when something breaks
|
||||
|
||||
Open [http://localhost:3333](http://localhost:3333) in your browser. For remote access, use `bash start.sh --host 0.0.0.0`.
|
||||
## Docs
|
||||
## Is OCM for you?
|
||||
|
||||
- English guide: docs/USAGE_GUIDE.en.md
|
||||
- 中文使用说明: docs/USAGE_GUIDE.zh-CN.md
|
||||
- FAQ: docs/FAQ.md
|
||||
- Security notes: docs/SECURITY.md
|
||||
- Changelog: docs/CHANGELOG.md
|
||||
**OCM is a good fit if:**
|
||||
- you already run OpenClaw locally
|
||||
- you want a visual control panel for agents, routing, logs, health, and backups
|
||||
- you are tired of editing nested config by hand
|
||||
- you want safer rollback / recovery nearby
|
||||
|
||||
**OCM is probably not the best starting point if:**
|
||||
- you have not installed OpenClaw yet
|
||||
- you expect every OS / channel workflow to be equally mature today
|
||||
- you want a hosted cloud dashboard instead of a local tool
|
||||
|
||||
## Features
|
||||
## What OCM helps you do
|
||||
|
||||
### 1) See your OpenClaw setup clearly
|
||||
- inspect agents and sub-agents in a tree
|
||||
- verify bindings and routing
|
||||
- view models, auth, usage, and health in one place
|
||||
|
||||
### 2) Operate OpenClaw with less risk
|
||||
- restart gateway
|
||||
- inspect logs
|
||||
- run OpenClaw commands from the built-in terminal
|
||||
- make config changes with rollback nearby
|
||||
|
||||
### 3) Recover faster when things go wrong
|
||||
- browse backups / snapshots
|
||||
- roll back config safely
|
||||
- keep troubleshooting and operational tools close to the same UI
|
||||
|
||||
## See it quickly
|
||||
|
||||
These are the highest-value surfaces for first-time users:
|
||||
|
||||
<p>
|
||||
<img src="docs/redacted-screenshots-refresh/dashboard-2026-03-07.jpg" width="860" />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<img src="docs/redacted-screenshots-refresh/agents-2026-03-07.jpg" width="280" />
|
||||
<img src="docs/redacted-screenshots-refresh/cli-2026-03-07.jpg" width="280" />
|
||||
<img src="docs/redacted-screenshots/actions.jpg" width="180" />
|
||||
</p>
|
||||
|
||||
More screenshots: see the [full usage guide](docs/USAGE_GUIDE.en.md) or the gallery below.
|
||||
|
||||
<details>
|
||||
<summary><b>Screenshots</b> (redacted: no personal paths, no Telegram IDs)</summary>
|
||||
<summary><b>Full screenshots gallery</b> (redacted: no personal paths, no Telegram IDs)</summary>
|
||||
|
||||
<p>
|
||||
<img src="docs/redacted-screenshots/dashboard.jpg" width="240" />
|
||||
@@ -52,7 +86,77 @@ Open [http://localhost:3333](http://localhost:3333) in your browser. For remote
|
||||
|
||||
</details>
|
||||
|
||||
- **Agent Management** — Add main agents and sub-agents through a guided setup flow. View all agents in a tree structure with model selection, workspace browsing, and inline configuration.
|
||||
## Quick Start (recommended path)
|
||||
|
||||
```bash
|
||||
# Clone
|
||||
git clone https://github.com/dtzp555-max/ocm.git
|
||||
cd ocm
|
||||
|
||||
# Run (no npm install needed)
|
||||
bash start.sh # macOS / Linux
|
||||
start.bat # Windows
|
||||
```
|
||||
|
||||
Then open [http://localhost:3333](http://localhost:3333).
|
||||
|
||||
For remote access, use:
|
||||
|
||||
```bash
|
||||
bash start.sh --host 0.0.0.0
|
||||
```
|
||||
|
||||
## First-run checklist
|
||||
|
||||
For a good first experience, do these first:
|
||||
|
||||
1. Confirm OCM found the correct OpenClaw directory
|
||||
2. Open **Dashboard** and check gateway health
|
||||
3. Open **Agents** / **Channels** and inspect bindings
|
||||
4. Open the built-in **Terminal** and run one OpenClaw command
|
||||
5. Check **Actions** / backup / rollback so recovery is nearby before you need it
|
||||
|
||||
## Current support status
|
||||
|
||||
**Best supported today**
|
||||
- macOS / Linux
|
||||
- local OpenClaw installations
|
||||
- local health / logs / ops / backup workflows
|
||||
- Telegram-first agent management workflows
|
||||
|
||||
**Supported, but not equally smooth in every case**
|
||||
- Discord agent / thread workflows
|
||||
- more advanced routing setups
|
||||
- mixed environment / service layouts
|
||||
|
||||
**Not the primary path today**
|
||||
- fully beginner-first OpenClaw onboarding
|
||||
- every OS / shell / service combination
|
||||
- WhatsApp-heavy sub-agent topology workflows
|
||||
|
||||
## Common friction points
|
||||
|
||||
The most common reasons OCM feels rough are not usually “the UI is broken”, but environment mismatch:
|
||||
|
||||
- OpenClaw itself is not fully healthy yet
|
||||
- wrong OpenClaw directory
|
||||
- path / permission issues
|
||||
- different service/runtime layouts across machines
|
||||
- channel workflow differences
|
||||
|
||||
That is why OCM should be thought of as a **control panel for an existing OpenClaw setup**, not a magic replacement for all installation complexity.
|
||||
|
||||
## Docs
|
||||
|
||||
- **Start here**: docs/USAGE_GUIDE.en.md
|
||||
- 中文使用说明: docs/USAGE_GUIDE.zh-CN.md
|
||||
- FAQ: docs/FAQ.md
|
||||
- Security notes: docs/SECURITY.md
|
||||
- Changelog: docs/CHANGELOG.md
|
||||
|
||||
## Features by area
|
||||
|
||||
- **Agent Management** — Add main agents and sub-agents through a guided setup flow. View all agents in a tree structure with model selection, workspace browsing, and inline configuration. New agents automatically get default Skills and Tool Groups, or you can customize them via the built-in Skills & Tools picker.
|
||||
- **Usage Statistics** — Real token usage data parsed directly from OpenClaw session files. Breakdown by model, agent, and day with a visual chart.
|
||||
- **Model & Auth** — Configure models from your registered provider list. Follow built-in guides for provider authentication setup.
|
||||
- **Built-in CLI** — Available from any page (top-right **Terminal** + bottom dock). Run OpenClaw commands with **real-time streaming output**, **Tab completion**, built-in presets, and your own saved favorites.
|
||||
@@ -60,14 +164,31 @@ Open [http://localhost:3333](http://localhost:3333) in your browser. For remote
|
||||
- **Backups / Rollback** — Browse auto-snapshots of `openclaw.json*` and restore any previous version (current config is auto-backed up first).
|
||||
- **Bilingual UI** — English and Chinese interface with one-click language switching.
|
||||
|
||||
## What's New (v0.8.x)
|
||||
## What's New (v0.9.x)
|
||||
|
||||
- **Docs refresh (v0.8.x)**: updated English + Chinese guides and refreshed redacted screenshots.
|
||||
- **README screenshots gallery**: all screenshots are now grouped into one collapsible section to keep the homepage short.
|
||||
- **Skills & Tools auto-config**: new agents/sub-agents automatically get default Skills (`memory-continuity`, `session-logs`) and Tool Groups (`fs`, `runtime`, `memory`, `sessions_spawn`, `subagents`). A collapsible Skills & Tools picker in the creation form lets you customize per agent.
|
||||
- **Discord support (v0.9.x)**: add agent/sub-agent flows for Discord (main agent binds channel; sub-agent binds thread).
|
||||
- **README screenshots gallery**: screenshots grouped into a collapsible section so the homepage stays shorter.
|
||||
- **Built-in CLI terminal**: run OpenClaw commands from any page with streaming output, presets, favorites, and Tab completion.
|
||||
- **Ops actions**: restart gateway, view logs, health check, backups (local + NAS), and cron management.
|
||||
- **Telegram-first workflow**: safer sub-agent setup flow + allowlist helper + warnings for group privacy.
|
||||
## Telegram Workflow & Safety
|
||||
|
||||
## Channel Support
|
||||
|
||||
OCM is a local UI for OpenClaw. Core features like agent trees, routing, models/auth, ops, backups, and the built-in CLI are channel-agnostic.
|
||||
|
||||
Current channel positioning:
|
||||
|
||||
- **Telegram** — best supported and most documented today
|
||||
- **Discord** — supported; recommended for private channels/threads with strict allowlist
|
||||
- **Feishu / Lark** — supported in broader OpenClaw ecosystems, but not a primary OCM workflow today
|
||||
- **WhatsApp** — not recommended for sub-agent topology workflows
|
||||
|
||||
## Recommended Workflows
|
||||
|
||||
OCM is **Telegram-first, not Telegram-only**. Telegram is the smoothest path today, but OCM is also useful for local ops, Discord routing, model/auth management, and backups.
|
||||
|
||||
### Telegram Workflow & Safety
|
||||
|
||||
OCM is designed primarily for **Telegram-based OpenClaw workflows**:
|
||||
|
||||
@@ -113,6 +234,18 @@ You can also create `manager-config.json` manually:
|
||||
|
||||
`manager-config.json` is gitignored and won't be committed.
|
||||
|
||||
## First-Run Experience
|
||||
|
||||
The first thing new users need is confidence that OCM is pointed at the right OpenClaw directory and that the gateway is healthy. The Dashboard, built-in CLI, and health/ops actions are intended to make that first-run check fast and visible.
|
||||
|
||||
Recommended first demo flow:
|
||||
|
||||
1. Start OCM
|
||||
2. Open Dashboard and confirm gateway health
|
||||
3. Open Agents / Routing and inspect bindings
|
||||
4. Run one CLI command from the built-in terminal
|
||||
5. Try backup / rollback from Ops
|
||||
|
||||
## Remote Access
|
||||
|
||||
By default OCM binds to `0.0.0.0` (all interfaces). Access it from another device on your LAN using the IP shown at startup. To restrict to localhost only:
|
||||
@@ -147,6 +280,12 @@ ocm/
|
||||
- **Frontend**: Vanilla HTML/CSS/JS embedded in a template literal — no build step, no framework
|
||||
- **Architecture**: Single-file, zero-dependency, runs anywhere Node.js runs
|
||||
|
||||
## Related Projects
|
||||
|
||||
- [clawkeeper](https://github.com/dtzp555-max/clawkeeper) — OpenClaw memory operations kit for doctor / provider switch / backup / restore workflows. *(archived)*
|
||||
- [execution-agent-planner](https://github.com/dtzp555-max/execution-agent-planner) — archived planning skill for deciding when work should stay with one execution agent or split across specialized workers.
|
||||
- [gh-pr-release-flow](https://github.com/dtzp555-max/gh-pr-release-flow) — skill for PR-first GitHub repos where release work should happen after merge.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
@@ -155,7 +294,38 @@ MIT
|
||||
|
||||
## 中文说明
|
||||
|
||||
OpenClaw Manager 是一个零依赖的本地 Web 管理界面，用于可视化管理 [OpenClaw](https://github.com/anthropics/openclaw) AI 智能体。所有代码在一个 `.js` 文件中，只需 Node.js 18+，不需要 `npm install`。
|
||||
OpenClaw Manager（OCM）是一个本地 OpenClaw 控制面板，用来更直观地管理 Agent、查看绑定关系、做健康检查、运行内置 CLI，并在改配置或排错时少踩坑。
|
||||
|
||||
### OCM 解决什么问题
|
||||
|
||||
直接使用 OpenClaw 很强，但日常维护很容易变成：
|
||||
- 改 `openclaw.json` 容易手滑
|
||||
- Agent / bot / 群 / 线程绑定关系很难一眼看清
|
||||
- 健康检查、日志、重启、回滚散落在多个终端命令里
|
||||
- 出问题时恢复链路不够顺手
|
||||
|
||||
OCM 的定位不是替代 OpenClaw，而是给现有 OpenClaw 环境加一个**本地控制台**。
|
||||
|
||||
### 适合谁
|
||||
|
||||
**适合：**
|
||||
- 已经在本机跑通 OpenClaw 的用户
|
||||
- 想更直观地管理 Agent / Routing / Health / Logs / Backups 的用户
|
||||
- 不想频繁手改复杂 JSON 的用户
|
||||
|
||||
**暂时不太适合：**
|
||||
- 还没装好 OpenClaw、希望 OCM 包办全部安装复杂度的新手
|
||||
- 默认期待所有平台 / 所有 channel 路线都同样成熟的用户
|
||||
- 想要云端托管产品而不是本地工具的用户
|
||||
|
||||
### OCM 最有价值的三件事
|
||||
|
||||
1. **看清你的 OpenClaw 结构**
|
||||
- Agent 树、绑定关系、模型、认证、健康状态更直观
|
||||
2. **更安全地做运维操作**
|
||||
- 重启 gateway、看日志、跑 CLI、改配置、回滚更顺手
|
||||
3. **出问题时恢复更快**
|
||||
- 备份、回滚、排查入口都更近
|
||||
|
||||
### 快速开始
|
||||
|
||||
@@ -166,43 +336,33 @@ bash start.sh # macOS / Linux
|
||||
start.bat # Windows
|
||||
```
|
||||
|
||||
访问 [http://localhost:3333](http://localhost:3333)。远程访问请使用 `bash start.sh --host 0.0.0.0`。
|
||||
打开 [http://localhost:3333](http://localhost:3333)。
|
||||
|
||||
### 功能
|
||||
### 第一次使用建议先做这几步
|
||||
|
||||
- **Agent 管理** — 添加主 Agent 和子 Agent，树状结构查看，内联切换模型，浏览工作区文件
|
||||
- **使用统计** — 从 OpenClaw 会话文件解析真实 Token 用量，按模型/Agent/日期维度展示
|
||||
- **模型与认证** — 管理注册模型列表，内置 Provider 认证引导
|
||||
- **内置终端** — 实时流式输出，预设命令，收藏夹，Tab 补全
|
||||
- **运维面板** — 重启网关、查看日志、健康检查、本地/NAS 备份、Cron 任务管理
|
||||
- **双语界面** — 中英文一键切换
|
||||
1. 确认 OCM 找到了正确的 OpenClaw 目录
|
||||
2. 打开 **Dashboard** 看 gateway 是否健康
|
||||
3. 打开 **Agents / Channels** 看绑定是否正确
|
||||
4. 打开内置 **Terminal** 跑一条 OpenClaw 命令
|
||||
5. 看一眼 **Actions / 备份 / 回滚**，确保恢复路径就在手边
|
||||
|
||||
### Telegram 场景与安全提示
|
||||
### 当前支持定位
|
||||
|
||||
OCM 主要面向 **Telegram 场景**：
|
||||
**目前最好用的场景：**
|
||||
- macOS / Linux
|
||||
- 本地 OpenClaw 环境
|
||||
- 本地 health / logs / ops / backup 工作流
|
||||
- Telegram-first 的 Agent 管理方式
|
||||
|
||||
- 通过群组绑定主 Agent，并在每条树下管理多个 Sub-Agent
|
||||
- 让每个 Agent 拥有独立 `workspace`、`SOUL.md`、`MEMORY.md`
|
||||
- 通过可视化方式更新 `openclaw.json`，减少手动改配置风险
|
||||
- 建议使用者已具备基础 OpenClaw CLI 操作经验（如 `onboard`、认证、查看网关日志）
|
||||
**支持，但不保证同样顺滑：**
|
||||
- Discord workflow
|
||||
- 更复杂的 routing / service 布局
|
||||
- 混合环境
|
||||
|
||||
关键安全设置（务必确认）：
|
||||
### 文档
|
||||
|
||||
- BotFather 里 **Allow Groups = ON**
|
||||
- BotFather 里 **Group Privacy = OFF**
|
||||
- 每个 Agent 群组只保留“你自己 + 对应 Agent/Sub-Agent”
|
||||
- 不要邀请其他人进组（会带来安全和 API 费用风险）
|
||||
|
||||
### 配置
|
||||
|
||||
启动脚本自动检测 `~/.openclaw` 目录。如需指定其他路径：
|
||||
|
||||
```bash
|
||||
bash start.sh --dir /path/to/.openclaw --port 8080
|
||||
```
|
||||
|
||||
也可手动创建 `manager-config.json`：
|
||||
|
||||
```json
|
||||
{ "dir": "~/.openclaw" }
|
||||
```
|
||||
- 英文使用说明：docs/USAGE_GUIDE.en.md
|
||||
- 中文使用说明：docs/USAGE_GUIDE.zh-CN.md
|
||||
- FAQ：docs/FAQ.md
|
||||
- 安全说明：docs/SECURITY.md
|
||||
- 更新记录：docs/CHANGELOG.md
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
This is a user-facing summary derived from `DEVLOG.md`.
|
||||
|
||||
## v0.9.4
|
||||
- **Skills & Tools auto-config**: New agents/sub-agents now automatically get default Skills (memory-continuity, agent-workflow, execution-agent-dispatch, session-logs) and Tool Groups (fs, runtime, memory, sessions_spawn, subagents).
|
||||
- Agent creation forms include a collapsible Skills & Tools picker with checkbox multi-select and quick-action buttons (Default / All / None).
|
||||
- All 4 creation endpoints (Telegram/Discord × Agent/Sub-Agent) support `skills` and `toolGroups` fields.
|
||||
|
||||
## v0.9.0
|
||||
- Agents: Telegram + Discord support in Add Agent / Add Sub-Agent wizard (main agent binds channel; sub-agent binds thread).
|
||||
- UI: top-center OCM version badge; improved Telegram/Discord setup guides.
|
||||
|
||||
## v0.8.2
|
||||
- Docs: reorganize README screenshots into a collapsible gallery to reduce scroll.
|
||||
- Docs: add Backups / Rollback screenshot and README feature blurb.
|
||||
|
||||
@@ -51,3 +51,12 @@ That said, your local OpenClaw config contains sensitive information. Follow the
|
||||
- don't share raw screenshots without redaction
|
||||
|
||||
See: `docs/SECURITY.md`.
|
||||
|
||||
|
||||
## Q: 为什么 OCM 暂时不推荐 WhatsApp 的 sub-agent 工作流？
|
||||
|
||||
WhatsApp 在 bot / group 自动化、权限边界和稳定路由上限制更多。
|
||||
|
||||
OCM 的 sub-agent 模式依赖清晰的会话边界、独立路由和可控权限，因此目前更推荐 Telegram / Discord 这类更容易做隔离的渠道。
|
||||
|
||||
如果未来支持 WhatsApp，更可能先从通知或轻量交互开始，而不是多 sub-agent 群聊拓扑。
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
# OCM Screenshot Refresh Brief
|
||||
|
||||
Goal: refresh only the highest-value README screenshots first, not every screenshot.
|
||||
|
||||
## Redaction rules
|
||||
Always hide or blur:
|
||||
- Telegram / Discord IDs
|
||||
- bindings / peer IDs / thread IDs
|
||||
- local filesystem paths containing Tao's name
|
||||
- account labels if they expose personal identifiers
|
||||
- anything that looks like a secret/token
|
||||
|
||||
## Priority 1 screenshots
|
||||
|
||||
### 1) Dashboard hero
|
||||
Purpose:
|
||||
- show OCM as a real control panel
|
||||
- support the README first-run / health story
|
||||
|
||||
Wanted state:
|
||||
- Dashboard page open
|
||||
- gateway looks healthy if possible
|
||||
- cards readable
|
||||
- top bar clean
|
||||
- no obvious warning/noise unless it helps credibility
|
||||
|
||||
Frame guidance:
|
||||
- browser window wide enough to show full dashboard naturally
|
||||
- keep top navigation visible
|
||||
- avoid cropping too tightly
|
||||
|
||||
### 2) Agents page
|
||||
Purpose:
|
||||
- show the core product value: visible agent topology / structure
|
||||
|
||||
Wanted state:
|
||||
- main agent + several sub-agents visible
|
||||
- structure easy to understand at a glance
|
||||
- avoid visual clutter where possible
|
||||
- keep model selectors/buttons visible, but not the focus
|
||||
|
||||
Frame guidance:
|
||||
- enough width to show the tree clearly
|
||||
- IDs and personal paths redacted
|
||||
|
||||
### 3) CLI / Terminal page
|
||||
Purpose:
|
||||
- show that OCM is not only a viewer; it can operate OpenClaw too
|
||||
|
||||
Wanted state:
|
||||
- built-in terminal open
|
||||
- a real command visible (recommended: `openclaw status` or `openclaw doctor`)
|
||||
- real output visible
|
||||
- do not use tutorial arrows / annotation bubbles
|
||||
|
||||
Frame guidance:
|
||||
- include command input and some output
|
||||
- avoid empty terminal state
|
||||
- redact paths / personal names
|
||||
|
||||
## Priority 2 screenshots
|
||||
- Actions menu
|
||||
- Backup / rollback
|
||||
- Channels
|
||||
- Models
|
||||
- Auth
|
||||
- Cron
|
||||
- Stats
|
||||
|
||||
## Selected refresh set (2026-03-07)
|
||||
- Dashboard: `docs/redacted-screenshots-refresh/dashboard-2026-03-07.jpg`
|
||||
- Agents: `docs/redacted-screenshots-refresh/agents-2026-03-07.jpg`
|
||||
- CLI: `docs/redacted-screenshots-refresh/cli-2026-03-07.jpg`
|
||||
- Keep using existing `docs/redacted-screenshots/actions.jpg` for now
|
||||
|
||||
## Notes
|
||||
- Existing `actions.jpg` is already strong and can stay for now.
|
||||
- The new Dashboard and Agents captures are preferred for README hero/overview use.
|
||||
- The new CLI capture is preferred because it shows a real command and real output.
|
||||
@@ -28,3 +28,25 @@ If you share screenshots publicly:
|
||||
- blur any tokens/keys if visible
|
||||
|
||||
This repo contains **redacted + annotated** screenshots under `docs/annotated-screenshots/`.
|
||||
|
||||
|
||||
## Discord safety
|
||||
|
||||
Recommended defaults (especially for shared/community servers):
|
||||
|
||||
- Prefer **private channels / private threads** as agent boundaries
|
||||
- Use a strict **allowlist** of channels/threads the bot may respond in
|
||||
- Avoid giving memory-enabled or high-privilege agents broad public exposure
|
||||
- Prefer least-privilege Discord permissions for the bot
|
||||
|
||||
## Feishu / Lark safety
|
||||
|
||||
Feishu is more enterprise-oriented and usually needs stricter permission design:
|
||||
|
||||
- Request the smallest permission scope possible
|
||||
- Treat chat/group visibility as a security boundary
|
||||
- Prefer separate chats/spaces for different agents to reduce context bleed
|
||||
|
||||
## WhatsApp note
|
||||
|
||||
WhatsApp is not a recommended target for sub-agent topology workflows. Constraints in bot/group automation make reliable multi-agent isolation and routing harder.
|
||||
|
||||
+55
-12
@@ -2,7 +2,7 @@
|
||||
|
||||
> Audience: People who already have OpenClaw running locally (you can run `openclaw status` and read `openclaw gateway logs`).
|
||||
>
|
||||
> Goal: Use **OpenClaw Manager (OCM)** to make agent/sub-agent setup and day-to-day ops **visual, safer, and easier to audit**.
|
||||
> Goal: Use **OpenClaw Manager (OCM)** as an **OpenClaw control panel** for agent setup, routing, health checks, built-in CLI, and safer config changes.
|
||||
|
||||
---
|
||||
|
||||
@@ -60,7 +60,18 @@ Recommended rule:
|
||||
|
||||
---
|
||||
|
||||
## 2) Start OCM (macOS)
|
||||
## 2) First-run mindset
|
||||
|
||||
For new users, the first win is not “configure everything” — it is:
|
||||
|
||||
1. Confirm OCM found the right OpenClaw directory
|
||||
2. Confirm the gateway is healthy
|
||||
3. Confirm you can inspect agents / bindings
|
||||
4. Confirm the built-in CLI works
|
||||
|
||||
That is why Dashboard + Routing + built-in CLI are the most important first-run surfaces.
|
||||
|
||||
## 3) Start OCM (macOS)
|
||||
|
||||
From the repo directory:
|
||||
|
||||
@@ -78,7 +89,7 @@ bash start.sh --host 127.0.0.1
|
||||
|
||||
---
|
||||
|
||||
## 3) Dashboard: check health first
|
||||
## 4) Dashboard: check health first
|
||||
|
||||
The Dashboard is your “sanity check”:
|
||||
|
||||
@@ -92,11 +103,11 @@ Screenshot:
|
||||
|
||||
---
|
||||
|
||||
## 4) Create a main agent (with its own Telegram bot)
|
||||
## 5) Create a main agent (with its own Telegram bot)
|
||||
|
||||
> Your `main` agent usually exists already. This section is for creating an additional **root agent** that owns its own Telegram bot/account.
|
||||
|
||||
### 4.1 BotFather prerequisites
|
||||
### 5.1 BotFather prerequisites
|
||||
|
||||
1) Create a bot
|
||||
- In Telegram, open **BotFather**
|
||||
@@ -115,7 +126,7 @@ If group privacy is ON, the bot can’t see normal group messages. The symptom o
|
||||
- “typing…” appears frequently
|
||||
- sometimes no response at all
|
||||
|
||||
### 4.2 Add the agent in OCM
|
||||
### 5.2 Add the agent in OCM
|
||||
|
||||
Go to **Agents**:
|
||||
|
||||
@@ -127,20 +138,21 @@ Click `+ Add Agent` and fill:
|
||||
- workspace path (recommended: separate folder per agent)
|
||||
- model (dropdown is sourced from `openclaw models list`)
|
||||
- the BotFather token
|
||||
- **Skills & Tools** (optional): expand the collapsible picker at the bottom to customize. By default, new agents get: `memory-continuity`, `session-logs` as Skills, and `group:fs`, `group:runtime`, `group:memory`, `sessions_spawn`, `subagents` as Tool Groups. Use the quick-action buttons (Default / All / None) to adjust.
|
||||
|
||||
OCM writes the agent + Telegram account/binding into `openclaw.json`.
|
||||
OCM writes the agent + Telegram account/binding + skills + tool groups into `openclaw.json`.
|
||||
|
||||
---
|
||||
|
||||
## 5) Create a sub-agent (recommended workflow)
|
||||
## 6) Create a sub-agent (recommended workflow)
|
||||
|
||||
### 5.1 Why a new group per sub-agent
|
||||
### 6.1 Why a new group per sub-agent
|
||||
|
||||
- clean context isolation
|
||||
- easier debugging
|
||||
- easy to “turn off” by muting a group
|
||||
|
||||
### 5.2 Step-by-step
|
||||
### 6.2 Step-by-step
|
||||
|
||||
In **Agents** → `+ Add Sub-Agent`:
|
||||
|
||||
@@ -165,6 +177,7 @@ Send a message in the new group. In logs you should see something like:
|
||||
- paste the Group ID
|
||||
- set workspace (recommended: its own folder)
|
||||
- choose model
|
||||
- **Skills & Tools** (optional): same picker as Add Agent — defaults are pre-selected, expand to customize
|
||||
|
||||
**Step 4 — Allowlist (optional but recommended)**
|
||||
|
||||
@@ -172,7 +185,37 @@ If you use `channels.telegram.allowFrom`, OCM can take “Your Telegram User ID
|
||||
|
||||
---
|
||||
|
||||
## 6) Verify bindings (Channels)
|
||||
|
||||
|
||||
## 6.5) Discord workflow (main agent + sub-agent)
|
||||
|
||||
OCM also supports Discord:
|
||||
|
||||
- **Main agent**: bind to a dedicated **Channel** (channelId)
|
||||
- **Sub-agent**: bind to a dedicated **Thread** under that channel (threadId)
|
||||
|
||||
### 6.5.1 Add a Discord main agent
|
||||
|
||||
Go to **Agents** → `+ Add Agent` → set **Channel = Discord**:
|
||||
|
||||
|
||||
|
||||
Steps:
|
||||
1) Create/select a dedicated Discord **channel** (private recommended)
|
||||
2) Right-click channel → **Copy Link** → paste into the form (auto-parses channelId)
|
||||
|
||||
### 6.5.2 Add a Discord sub-agent (thread-first)
|
||||
|
||||
Go to **Agents** → `+ Add Sub-Agent` → set **Channel = Discord (thread only)**:
|
||||
|
||||
|
||||
|
||||
Steps:
|
||||
1) Create a **thread** under the main channel (one thread per task)
|
||||
2) If it is a private thread, add the bot to the thread
|
||||
3) Right-click thread → **Copy Link** → paste into the form (auto-parses threadId)
|
||||
|
||||
## 7) Verify bindings (Channels)
|
||||
|
||||
Go to **Channels**:
|
||||
|
||||
@@ -184,7 +227,7 @@ Here you can quickly validate:
|
||||
|
||||
---
|
||||
|
||||
## 7) Model settings (Models)
|
||||
## 8) Model settings (Models)
|
||||
|
||||
Go to **Models**:
|
||||
|
||||
|
||||
+57
-14
@@ -2,7 +2,7 @@
|
||||
|
||||
> 面向：已经在本机安装并跑通 OpenClaw 的用户（至少会用 `openclaw status` / `openclaw gateway logs`）
|
||||
>
|
||||
> 目标：用 **OpenClaw Manager (OCM)** 把“创建 Agent / Sub-Agent、绑定 Telegram 群、管理模型/认证、看用量、看 cron”这套流程做成可视化、可回溯、低风险。
|
||||
> 目标：把 **OpenClaw Manager (OCM)** 当成 **OpenClaw 控制台** 来用：管理 Agent、查看 Routing、做健康检查、运行内置 CLI，并更安全地修改配置。
|
||||
|
||||
---
|
||||
|
||||
@@ -54,9 +54,20 @@ OCM 的定位：**把配置变更“可视化 + 可检查 + 可回滚（配合
|
||||
|
||||
---
|
||||
|
||||
## 2) 启动与进入 OCM
|
||||
## 2) 第一次使用时最该确认什么
|
||||
|
||||
### 2.1 启动（macOS）
|
||||
对新用户来说，第一步不是“先把所有配置都改完”，而是先确认四件事：
|
||||
|
||||
1. OCM 找到的是正确的 OpenClaw 目录
|
||||
2. Gateway 是健康的
|
||||
3. Agent / Routing 能正常查看
|
||||
4. 内置终端可以正常跑命令
|
||||
|
||||
所以第一次使用时，最重要的页面其实是 Dashboard、Routing 和内置终端。
|
||||
|
||||
## 3) 启动与进入 OCM
|
||||
|
||||
### 3.1 启动（macOS）
|
||||
|
||||
在 OCM 目录：
|
||||
|
||||
@@ -68,7 +79,7 @@ bash start.sh
|
||||
|
||||
> 需要限制只能本机访问：`bash start.sh --host 127.0.0.1`
|
||||
|
||||
### 2.2 Dashboard（先看健康状态）
|
||||
### 3.2 Dashboard（先看健康状态）
|
||||
|
||||
建议第一步先看 Dashboard，确认：
|
||||
- 机器资源（CPU/RAM/DISK）
|
||||
@@ -81,11 +92,11 @@ bash start.sh
|
||||
|
||||
---
|
||||
|
||||
## 3) 创建主 Agent（Main Agent / 独立 Bot）
|
||||
## 4) 创建主 Agent（Main Agent / 独立 Bot）
|
||||
|
||||
> 你的 `main` 一般是默认存在的；这里重点讲“新增一个 **拥有独立 Telegram bot 的主 Agent**”。
|
||||
|
||||
### 3.1 BotFather 侧准备（必须）
|
||||
### 4.1 BotFather 侧准备（必须）
|
||||
|
||||
1) 创建 bot
|
||||
- 在 Telegram 找 **BotFather**
|
||||
@@ -101,7 +112,7 @@ bash start.sh
|
||||
|
||||
> 如果 Group Privacy 没关，bot 在群里看不到普通消息，会表现成“经常 typing 但没输出 / 没反应”。
|
||||
|
||||
### 3.2 在 OCM 添加主 Agent
|
||||
### 4.2 在 OCM 添加主 Agent
|
||||
|
||||
进入 **Agents** 页面：
|
||||
|
||||
@@ -112,19 +123,20 @@ bash start.sh
|
||||
- workspace 路径（建议独立目录）
|
||||
- 选择模型（下拉来自 `openclaw models list`，更不容易选错）
|
||||
- 填入刚拿到的 bot token
|
||||
- **Skills & Tools**（可选）：展开表单底部的折叠面板可自定义。默认预设：Skills 包含 `memory-continuity`、`session-logs`；Tool Groups 包含 `group:fs`、`group:runtime`、`group:memory`、`sessions_spawn`、`subagents`。提供「仅默认 / 全选 / 清空」快捷按钮。
|
||||
|
||||
保存后，OCM 会把这颗主 Agent 写进 `openclaw.json`，并把 bot token 绑定到对应 `accountId`。
|
||||
保存后，OCM 会把主 Agent + skills + tools 写进 `openclaw.json`，并把 bot token 绑定到对应 `accountId`。
|
||||
|
||||
---
|
||||
|
||||
## 4) 创建 Sub-Agent（最常用）
|
||||
## 5) 创建 Sub-Agent（最常用）
|
||||
|
||||
### 4.1 为什么 Sub-Agent 要用“新群”
|
||||
### 5.1 为什么 Sub-Agent 要用“新群”
|
||||
|
||||
- 让每个 Sub-Agent 有自己独立的对话上下文、任务边界
|
||||
- 出问题直接在该群排查，不污染主 Agent 的对话
|
||||
|
||||
### 4.2 Sub-Agent 创建流程（逐步）
|
||||
### 5.2 Sub-Agent 创建流程（逐步）
|
||||
|
||||
进入 **Agents** 页面 → 点击 `+ Add Sub-Agent`，按引导做：
|
||||
|
||||
@@ -148,6 +160,7 @@ openclaw gateway logs --follow
|
||||
- 填 Group ID
|
||||
- workspace（建议单独目录）
|
||||
- 选择模型
|
||||
- **Skills & Tools**（可选）：和 Add Agent 相同的选择器，默认预设已勾选，展开可自定义
|
||||
|
||||
#### Step 4：写 allowlist（推荐）
|
||||
如果你启用了 Telegram 的 allowlist（例如 `channels.telegram.allowFrom`），
|
||||
@@ -155,7 +168,37 @@ OCM 的表单里可以填 “Your Telegram User ID”，让它自动把你的 us
|
||||
|
||||
---
|
||||
|
||||
## 5) 绑定检查（Channels 页）
|
||||
|
||||
|
||||
## 6) Discord 工作流（主 Agent + Sub-Agent）
|
||||
|
||||
OCM 也支持 Discord：
|
||||
|
||||
- **主 Agent**：绑定到一个专用 **Channel**（channelId）
|
||||
- **Sub-Agent**：绑定到该 Channel 下的专用 **Thread**（threadId，thread-first）
|
||||
|
||||
### 5.1 添加 Discord 主 Agent
|
||||
|
||||
进入 **Agents** → `+ Add Agent` → 选择 **渠道 = Discord**：
|
||||
|
||||
|
||||
|
||||
步骤：
|
||||
1) 创建/选择一个专用 Discord Channel（建议私密）
|
||||
2) 右键 Channel → **Copy Link** → 粘贴到表单（自动解析 channelId）
|
||||
|
||||
### 5.2 添加 Discord Sub-Agent（Thread 优先）
|
||||
|
||||
进入 **Agents** → `+ Add Sub-Agent` → 选择 **渠道 = Discord (thread only)**：
|
||||
|
||||
|
||||
|
||||
步骤：
|
||||
1) 在主 Channel 下新建 Thread（建议“一个任务一个 thread”）
|
||||
2) 如果是 private thread，需要把 bot 拉进 thread
|
||||
3) 右键 Thread → **Copy Link** → 粘贴到表单（自动解析 threadId）
|
||||
|
||||
## 7) 绑定检查（Channels 页）
|
||||
|
||||
进入 **Channels**：
|
||||
|
||||
@@ -169,7 +212,7 @@ OCM 的表单里可以填 “Your Telegram User ID”，让它自动把你的 us
|
||||
|
||||
---
|
||||
|
||||
## 6) 模型管理（Models 页）
|
||||
## 8) 模型管理（Models 页）
|
||||
|
||||
进入 **模型**：
|
||||
|
||||
@@ -181,7 +224,7 @@ OCM 的表单里可以填 “Your Telegram User ID”，让它自动把你的 us
|
||||
|
||||
---
|
||||
|
||||
## 7) 认证管理（Auth 页）
|
||||
## 9) 认证管理（Auth 页）
|
||||
|
||||
进入 **认证**：
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 126 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 142 KiB |
+622
-115
File diff suppressed because it is too large
Load Diff
+2
-2
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "openclaw-manager",
|
||||
"version": "0.8.2",
|
||||
"description": "A local web UI for managing OpenClaw AI agents — no npm install required",
|
||||
"version": "1.0.0-rc1",
|
||||
"description": "A local web UI for managing OpenClaw AI agents \u2014 no npm install required",
|
||||
"main": "openclaw-manager.js",
|
||||
"scripts": {
|
||||
"start": "node openclaw-manager.js",
|
||||
|
||||
Reference in New Issue
Block a user