diff --git a/README.md b/README.md index 933afee..bc73250 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,19 @@ Open [http://localhost:3333](http://localhost:3333) in your browser. For remote **Screenshots** — Redacted UI walkthrough (no personal paths, no Telegram IDs): -![](docs/redacted-screenshots/dashboard.jpg) +![](docs/annotated-screenshots/dashboard.jpg) -![](docs/redacted-screenshots/agents.jpg) +![](docs/annotated-screenshots/agents.jpg) -![](docs/redacted-screenshots/channels.jpg) +![](docs/annotated-screenshots/channels.jpg) -![](docs/redacted-screenshots/models.jpg) +![](docs/annotated-screenshots/models.jpg) -![](docs/redacted-screenshots/auth.jpg) +![](docs/annotated-screenshots/auth.jpg) -![](docs/redacted-screenshots/stats.jpg) +![](docs/annotated-screenshots/stats.jpg) -![](docs/redacted-screenshots/cron.jpg) +![](docs/annotated-screenshots/cron.jpg) **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. @@ -50,7 +50,7 @@ Open [http://localhost:3333](http://localhost:3333) in your browser. For remote **Built-in CLI** — Run any OpenClaw CLI command with real-time streaming output. Includes tab completion and saved favorites. -![](docs/redacted-screenshots/cli.jpg) +![](docs/annotated-screenshots/cli.jpg) **Ops Panel** — Restart gateway, view logs, run health checks, manage backups (local + NAS via SFTP/rsync), and handle cron tasks. diff --git a/docs/USAGE_GUIDE.en.md b/docs/USAGE_GUIDE.en.md index 195be03..63c6f3d 100644 --- a/docs/USAGE_GUIDE.en.md +++ b/docs/USAGE_GUIDE.en.md @@ -88,7 +88,7 @@ The Dashboard is your “sanity check”: Screenshot: -![](redacted-screenshots/dashboard.jpg) +![](annotated-screenshots/dashboard.jpg) --- @@ -119,7 +119,7 @@ If group privacy is ON, the bot can’t see normal group messages. The symptom o Go to **Agents**: -![](redacted-screenshots/agents.jpg) +![](annotated-screenshots/agents.jpg) Click `+ Add Agent` and fill: @@ -176,7 +176,7 @@ If you use `channels.telegram.allowFrom`, OCM can take “Your Telegram User ID Go to **Channels**: -![](redacted-screenshots/channels.jpg) +![](annotated-screenshots/channels.jpg) Here you can quickly validate: - which agent is bound to which Telegram peer @@ -188,7 +188,7 @@ Here you can quickly validate: Go to **Models**: -![](redacted-screenshots/models.jpg) +![](annotated-screenshots/models.jpg) Key idea: - OCM uses the real CLI model list (`openclaw models list`) for dropdowns. @@ -200,7 +200,7 @@ Key idea: Go to **Auth**: -![](redacted-screenshots/auth.jpg) +![](annotated-screenshots/auth.jpg) Use this page to: - see which provider profiles exist @@ -212,7 +212,7 @@ Use this page to: Go to **Stats**: -![](redacted-screenshots/stats.jpg) +![](annotated-screenshots/stats.jpg) You can break down usage by: - model @@ -227,7 +227,7 @@ OCM parses usage from OpenClaw session JSONL files. Go to **Cron**: -![](redacted-screenshots/cron.jpg) +![](annotated-screenshots/cron.jpg) You can: - see scheduled tasks (backup / update / health) @@ -250,7 +250,7 @@ Highlights: Screenshot: -![](redacted-screenshots/cli.jpg) +![](annotated-screenshots/cli.jpg) ## 11) Fast troubleshooting @@ -272,4 +272,4 @@ Check (in order): ## Notes about screenshots All screenshots in this guide are **redacted** (no personal paths, no Telegram IDs). -They live under `docs/redacted-screenshots/`. +They live under `docs/annotated-screenshots/`. diff --git a/docs/USAGE_GUIDE.zh-CN.md b/docs/USAGE_GUIDE.zh-CN.md index a5acd73..99b5196 100644 --- a/docs/USAGE_GUIDE.zh-CN.md +++ b/docs/USAGE_GUIDE.zh-CN.md @@ -77,7 +77,7 @@ bash start.sh 截图示例: -![](redacted-screenshots/dashboard.jpg) +![](annotated-screenshots/dashboard.jpg) --- @@ -105,7 +105,7 @@ bash start.sh 进入 **Agents** 页面: -![](redacted-screenshots/agents.jpg) +![](annotated-screenshots/agents.jpg) 点击 `+ Add Agent`,按表单填写: - Agent id / name @@ -159,7 +159,7 @@ OCM 的表单里可以填 “Your Telegram User ID”,让它自动把你的 us 进入 **Channels**: -![](redacted-screenshots/channels.jpg) +![](annotated-screenshots/channels.jpg) 这里能一眼看到: - 哪个 agent 绑定了哪个 Telegram peer(群) @@ -173,7 +173,7 @@ OCM 的表单里可以填 “Your Telegram User ID”,让它自动把你的 us 进入 **模型**: -![](redacted-screenshots/models.jpg) +![](annotated-screenshots/models.jpg) 关键点: - 主模型(primary)和 fallback 链 @@ -185,7 +185,7 @@ OCM 的表单里可以填 “Your Telegram User ID”,让它自动把你的 us 进入 **认证**: -![](redacted-screenshots/auth.jpg) +![](annotated-screenshots/auth.jpg) 这里主要用来: - 看当前有哪些 provider profile @@ -197,7 +197,7 @@ OCM 的表单里可以填 “Your Telegram User ID”,让它自动把你的 us 进入 **Stats**: -![](redacted-screenshots/stats.jpg) +![](annotated-screenshots/stats.jpg) 你可以按: - 按模型聚合 @@ -222,13 +222,13 @@ OCM 内置一个 CLI 面板,用来直接运行 OpenClaw 命令(例如:`ope 截图示例: -![](redacted-screenshots/cli.jpg) +![](annotated-screenshots/cli.jpg) ## 9) Cron(定时任务) 进入 **Cron**: -![](redacted-screenshots/cron.jpg) +![](annotated-screenshots/cron.jpg) 用途: - 查看有哪些健康检查/更新/备份任务 @@ -264,4 +264,4 @@ OCM 内置一个 CLI 面板,用来直接运行 OpenClaw 命令(例如:`ope ## 附:截图说明 -本文截图来自 `docs/redacted-screenshots/`,已做脱敏(路径用户名、Telegram 绑定 ID 等均已模糊处理)。 +本文截图来自 `docs/annotated-screenshots/`,已做脱敏(路径用户名、Telegram 绑定 ID 等均已模糊处理)。 diff --git a/docs/annotated-screenshots/agents.jpg b/docs/annotated-screenshots/agents.jpg new file mode 100644 index 0000000..f4bd816 Binary files /dev/null and b/docs/annotated-screenshots/agents.jpg differ diff --git a/docs/annotated-screenshots/auth.jpg b/docs/annotated-screenshots/auth.jpg new file mode 100644 index 0000000..39a138f Binary files /dev/null and b/docs/annotated-screenshots/auth.jpg differ diff --git a/docs/annotated-screenshots/channels.jpg b/docs/annotated-screenshots/channels.jpg new file mode 100644 index 0000000..c6c1cd7 Binary files /dev/null and b/docs/annotated-screenshots/channels.jpg differ diff --git a/docs/annotated-screenshots/cli.jpg b/docs/annotated-screenshots/cli.jpg new file mode 100644 index 0000000..3134e81 Binary files /dev/null and b/docs/annotated-screenshots/cli.jpg differ diff --git a/docs/annotated-screenshots/cron.jpg b/docs/annotated-screenshots/cron.jpg new file mode 100644 index 0000000..efb2bba Binary files /dev/null and b/docs/annotated-screenshots/cron.jpg differ diff --git a/docs/annotated-screenshots/dashboard.jpg b/docs/annotated-screenshots/dashboard.jpg new file mode 100644 index 0000000..2841c33 Binary files /dev/null and b/docs/annotated-screenshots/dashboard.jpg differ diff --git a/docs/annotated-screenshots/models.jpg b/docs/annotated-screenshots/models.jpg new file mode 100644 index 0000000..b3840c2 Binary files /dev/null and b/docs/annotated-screenshots/models.jpg differ diff --git a/docs/annotated-screenshots/stats.jpg b/docs/annotated-screenshots/stats.jpg new file mode 100644 index 0000000..cdcdd0c Binary files /dev/null and b/docs/annotated-screenshots/stats.jpg differ