@openbrt/weclawbotctl 0.1.1 → 0.1.3

package/README.md

@@ -1,8 +1,65 @@
-# WeClawBot Agent CLI and OpenClaw Plugin
+# WeClawBot Agent CLI
 
 This package installs the cross-platform `weclawbotctl` command for pairing
-any local Agent with a WeClawBot screen. It also gives OpenClaw the
-`weclawbot-curator` skill, a local
+any local Agent with a WeClawBot screen. It works from OpenClaw, Hermes,
+Codex, Claude Code, Gemini CLI, OpenCode, or a shell script through the same
+local MQTT profile.
+
+## Tell Your Agent
+
+Give your coding agent one sentence:
+
+```text
+Install @openbrt/weclawbotctl and connect to my WeClawBot screen with pairing code 123456.
+```
+
+Replace `123456` with the six-digit code shown on the screen. The agent should
+then install this npm package, bind the screen, run the online doctor check,
+and use `weclawbotctl thinking`, `weclawbotctl idle`, and `weclawbotctl screen`
+when it works.
+
+## Agent Instructions
+
+If a user asks you to install, enable, connect, or pair WeClawBot and gives a
+six-digit pairing code, do this autonomously:
+
+```bash
+npm install -g @openbrt/weclawbotctl
+weclawbotctl bind 123456 --name "$AGENT_NAME"
+weclawbotctl doctor --online
+```
+
+Use your product name for `$AGENT_NAME`, such as `codex`, `claude-code`,
+`gemini-cli`, `opencode`, `hermes`, or `openclaw`. If global npm installation
+is not available, use the one-shot form:
+
+```bash
+npm exec --package @openbrt/weclawbotctl -- weclawbotctl bind 123456 --name "$AGENT_NAME"
+npm exec --package @openbrt/weclawbotctl -- weclawbotctl doctor --online
+```
+
+Do not ask the user for an MQTT URL, username, password, Wi-Fi password,
+WeChat credential, port, or webhook. The pairing code is enough. The local MQTT
+credential is stored at `~/.config/weclawbot/agent-mqtt.json` with mode `0600`.
+
+When doing visible work, publish a temporary activity:
+
+```bash
+task_id="$(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)"
+weclawbotctl thinking --id "$task_id" --ttl 45
+# Do the work.
+weclawbotctl idle --id "$task_id"
+```
+
+To put content on the screen, render a valid WeClawBot `screen_document` JSON
+and send it:
+
+```bash
+weclawbotctl screen /path/to/screen-document.json
+```
+
+The package also includes an OpenClaw integration: the `weclawbot-curator`
+skill, a local
 `weclawbot_validate_screen_document` tool, a `weclawbot_validate_activity`
 tool, and a small outbound bridge
 service. The bridge polls `weclawbot.link`; no public HTTP endpoint, port
@@ -21,8 +78,8 @@ For one-shot use without a global install:
 npm exec --package @openbrt/weclawbotctl -- weclawbotctl status
 ```
 
-`weclawbotctl` is the common pairing and MQTT profile manager for OpenClaw,
-Hermes, Codex, Claude Code, Gemini CLI, OpenCode, or a shell script.
+`weclawbotctl` is the common pairing and MQTT profile manager for any local
+Agent.
 
 To install the OpenClaw plugin itself from npm after the package is published:
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openbrt/weclawbotctl",
-  "version": "0.1.1",
-  "description": "WeClawBot MQTT pairing CLI, direct-control tools, and OpenClaw plugin.",
+  "version": "0.1.3",
+  "description": "WeClawBot pairing and screen-control CLI for local AI agents.",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -10,7 +10,11 @@
     "esp32",
     "e-paper",
     "openclaw",
-    "agent"
+    "agent",
+    "codex",
+    "claude-code",
+    "gemini-cli",
+    "hermes"
   ],
   "engines": {
     "node": ">=20"