taodeng/ocm

Fork 0

mirror of https://github.com/dtzp555-max/ocm.git synced 2026-07-21 21:15:08 +00:00

Files

T

taodeng 8e9b07a01e docs: add annotated screenshots with arrows (README + guides)

2026-02-28 14:46:52 +10:00

6.6 KiB

Raw Blame History

OCM Usage Guide (with screenshots)

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.

0) The pain: why OCM exists

Creating and maintaining OpenClaw agents is powerful, but the “default workflow” is often messy:

Editing openclaw.json is risky

Deep/nested config, many fields.
One accidental overwrite can break multiple agents (tokens, bindings, accountIds).

Sub-agent topology is hard to see

With multiple bots + multiple groups, it’s not obvious which agent is bound to which Telegram peer.

Model IDs are easy to misconfigure

A wrong provider/model-id can silently degrade performance, cause timeouts, or produce “typing…” with no reply.

Usage and troubleshooting take time

Without tooling, you’re digging through JSONL sessions and gateway logs to answer: “who used tokens?”, “what failed?”, “which provider?”

OCM’s role: a zero-dependency local UI that helps you view and update OpenClaw configuration safely, keep changes auditable, and centralize common ops.

1) Why Telegram groups are the best way to build sub-agents

Think of it as:

One Telegram group = one agent boundary (context + purpose + workspace).

Benefits

Clear isolation

Each agent speaks only inside its own group.
Less cross-contamination between tasks.

Controllable context

The group chat is the agent’s input stream.
You can keep an agent “clean” by keeping the group focused.

Natural delegation

A main agent can coordinate; sub-agents can specialize (tech / travel / finance / translation, etc.).

Auditable

You can see exactly which message triggered which response.

Safety / cost: keep groups private

Recommended rule:

Each agent group should contain only you + the bot (and optionally your second account).
Don’t invite other people:
- cost: anyone can trigger token usage
- safety: higher risk of prompt-injection / accidental tool actions

2) Start OCM (macOS)

From the repo directory:

bash start.sh

Then open: http://localhost:3333

Restrict to localhost only:

bash start.sh --host 127.0.0.1

3) Dashboard: check health first

The Dashboard is your “sanity check”:

CPU / RAM / Disk
gateway running status
agent counts

Screenshot:

4) 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

Create a bot

In Telegram, open BotFather
Run /newbot → follow prompts → copy the bot token

Allow groups

BotFather → your bot → Bot Settings
Allow Groups = ON

Disable group privacy (critical)

BotFather → your bot → Bot Settings → Group Privacy
Group Privacy = OFF

If group privacy is ON, the bot can’t see normal group messages. The symptom often looks like:

slow replies
“typing…” appears frequently
sometimes no response at all

4.2 Add the agent in OCM

Go to Agents:

Click + Add Agent and fill:

agent id / name
workspace path (recommended: separate folder per agent)
model (dropdown is sourced from openclaw models list)
the BotFather token

OCM writes the agent + Telegram account/binding into openclaw.json.

5) Create a sub-agent (recommended workflow)

5.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

In Agents → + Add Sub-Agent:

Step 1 — Create a Telegram group

private group
add only: you + the bot

Step 2 — Get the Group ID (peer id)

Use gateway logs:

openclaw gateway logs --follow

Send a message in the new group. In logs you should see something like:

-100xxxxxxxxxx (Telegram group id)

Step 3 — Fill the sub-agent form

choose the Parent Agent (which bot/account to share)
paste the Group ID
set workspace (recommended: its own folder)
choose model

Step 4 — Allowlist (optional but recommended)

If you use channels.telegram.allowFrom, OCM can take “Your Telegram User ID” and append it automatically to the allowlist.

6) Verify bindings (Channels)

Go to Channels:

Here you can quickly validate:

which agent is bound to which Telegram peer
whether main has the catch-all binding (if you use that pattern)

7) Model settings (Models)

Go to Models:

Key idea:

OCM uses the real CLI model list (openclaw models list) for dropdowns.
This reduces “invalid model-id” mistakes.

8) Credentials (Auth)

Go to Auth:

Use this page to:

see which provider profiles exist
troubleshoot expired/missing tokens

9) Usage stats (Stats)

Go to Stats:

You can break down usage by:

model
agent
time window

OCM parses usage from OpenClaw session JSONL files.

10) Cron jobs (Cron)

Go to Cron:

You can:

see scheduled tasks (backup / update / health)
run tasks manually
enable/disable entries

11) Built-in CLI Terminal

OCM includes a built-in terminal panel to run OpenClaw CLI commands directly (for example: openclaw status, openclaw gateway logs --follow, openclaw doctor).

How to open: click ⌨️ Terminal in the top navigation, or use the bottom CLI panel.

Highlights:

Tab completion while typing commands
Common commands dropdown to insert templates quickly
Favorites: save frequently used commands and run them with one click
Streaming output (stdout/stderr) for faster debugging