mirror of
https://github.com/dtzp555-max/ocm.git
synced 2026-07-21 21:15:08 +00:00
Improve startup UX and docs positioning
This commit is contained in:
+18
-7
@@ -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,7 +103,7 @@ 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.
|
||||
|
||||
@@ -132,7 +143,7 @@ OCM writes the agent + Telegram account/binding 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
|
||||
|
||||
@@ -202,7 +213,7 @@ Steps:
|
||||
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)
|
||||
|
||||
## 6) Verify bindings (Channels)
|
||||
## 7) Verify bindings (Channels)
|
||||
|
||||
Go to **Channels**:
|
||||
|
||||
@@ -214,7 +225,7 @@ Here you can quickly validate:
|
||||
|
||||
---
|
||||
|
||||
## 7) Model settings (Models)
|
||||
## 8) Model settings (Models)
|
||||
|
||||
Go to **Models**:
|
||||
|
||||
|
||||
@@ -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,7 +54,18 @@ OCM 的定位:**把配置变更“可视化 + 可检查 + 可回滚(配合
|
||||
|
||||
---
|
||||
|
||||
## 2) 启动与进入 OCM
|
||||
## 2) 第一次使用时最该确认什么
|
||||
|
||||
对新用户来说,第一步不是“先把所有配置都改完”,而是先确认四件事:
|
||||
|
||||
1. OCM 找到的是正确的 OpenClaw 目录
|
||||
2. Gateway 是健康的
|
||||
3. Agent / Routing 能正常查看
|
||||
4. 内置终端可以正常跑命令
|
||||
|
||||
所以第一次使用时,最重要的页面其实是 Dashboard、Routing 和内置终端。
|
||||
|
||||
## 3) 启动与进入 OCM
|
||||
|
||||
### 2.1 启动(macOS)
|
||||
|
||||
@@ -81,7 +92,7 @@ bash start.sh
|
||||
|
||||
---
|
||||
|
||||
## 3) 创建主 Agent(Main Agent / 独立 Bot)
|
||||
## 4) 创建主 Agent(Main Agent / 独立 Bot)
|
||||
|
||||
> 你的 `main` 一般是默认存在的;这里重点讲“新增一个 **拥有独立 Telegram bot 的主 Agent**”。
|
||||
|
||||
@@ -117,7 +128,7 @@ bash start.sh
|
||||
|
||||
---
|
||||
|
||||
## 4) 创建 Sub-Agent(最常用)
|
||||
## 5) 创建 Sub-Agent(最常用)
|
||||
|
||||
### 4.1 为什么 Sub-Agent 要用“新群”
|
||||
|
||||
@@ -157,7 +168,7 @@ OCM 的表单里可以填 “Your Telegram User ID”,让它自动把你的 us
|
||||
|
||||
|
||||
|
||||
## 5) Discord 工作流(主 Agent + Sub-Agent)
|
||||
## 6) Discord 工作流(主 Agent + Sub-Agent)
|
||||
|
||||
OCM 也支持 Discord:
|
||||
|
||||
@@ -185,7 +196,7 @@ OCM 也支持 Discord:
|
||||
2) 如果是 private thread,需要把 bot 拉进 thread
|
||||
3) 右键 Thread → **Copy Link** → 粘贴到表单(自动解析 threadId)
|
||||
|
||||
## 5) 绑定检查(Channels 页)
|
||||
## 7) 绑定检查(Channels 页)
|
||||
|
||||
进入 **Channels**:
|
||||
|
||||
@@ -199,7 +210,7 @@ OCM 也支持 Discord:
|
||||
|
||||
---
|
||||
|
||||
## 6) 模型管理(Models 页)
|
||||
## 8) 模型管理(Models 页)
|
||||
|
||||
进入 **模型**:
|
||||
|
||||
@@ -211,7 +222,7 @@ OCM 也支持 Discord:
|
||||
|
||||
---
|
||||
|
||||
## 7) 认证管理(Auth 页)
|
||||
## 9) 认证管理(Auth 页)
|
||||
|
||||
进入 **认证**:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user