@openbrt/weclawbotctl 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/package.json +7 -3
package/README.md
CHANGED
|
@@ -5,6 +5,59 @@ any local Agent with a WeClawBot screen. It works from OpenClaw, Hermes,
|
|
|
5
5
|
Codex, Claude Code, Gemini CLI, OpenCode, or a shell script through the same
|
|
6
6
|
local MQTT profile.
|
|
7
7
|
|
|
8
|
+
## Tell Your Agent
|
|
9
|
+
|
|
10
|
+
Give your coding agent one sentence:
|
|
11
|
+
|
|
12
|
+
```text
|
|
13
|
+
Install @openbrt/weclawbotctl and connect to my WeClawBot screen with pairing code 123456.
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Replace `123456` with the six-digit code shown on the screen. The agent should
|
|
17
|
+
then install this npm package, bind the screen, run the online doctor check,
|
|
18
|
+
and use `weclawbotctl thinking`, `weclawbotctl idle`, and `weclawbotctl screen`
|
|
19
|
+
when it works.
|
|
20
|
+
|
|
21
|
+
## Agent Instructions
|
|
22
|
+
|
|
23
|
+
If a user asks you to install, enable, connect, or pair WeClawBot and gives a
|
|
24
|
+
six-digit pairing code, do this autonomously:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install -g @openbrt/weclawbotctl
|
|
28
|
+
weclawbotctl bind 123456 --name "$AGENT_NAME"
|
|
29
|
+
weclawbotctl doctor --online
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Use your product name for `$AGENT_NAME`, such as `codex`, `claude-code`,
|
|
33
|
+
`gemini-cli`, `opencode`, `hermes`, or `openclaw`. If global npm installation
|
|
34
|
+
is not available, use the one-shot form:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npm exec --package @openbrt/weclawbotctl -- weclawbotctl bind 123456 --name "$AGENT_NAME"
|
|
38
|
+
npm exec --package @openbrt/weclawbotctl -- weclawbotctl doctor --online
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Do not ask the user for an MQTT URL, username, password, Wi-Fi password,
|
|
42
|
+
WeChat credential, port, or webhook. The pairing code is enough. The local MQTT
|
|
43
|
+
credential is stored at `~/.config/weclawbot/agent-mqtt.json` with mode `0600`.
|
|
44
|
+
|
|
45
|
+
When doing visible work, publish a temporary activity:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
task_id="$(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)"
|
|
49
|
+
weclawbotctl thinking --id "$task_id" --ttl 45
|
|
50
|
+
# Do the work.
|
|
51
|
+
weclawbotctl idle --id "$task_id"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
To put content on the screen, render a valid WeClawBot `screen_document` JSON
|
|
55
|
+
and send it:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
weclawbotctl screen /path/to/screen-document.json
|
|
59
|
+
```
|
|
60
|
+
|
|
8
61
|
The package also includes an OpenClaw integration: the `weclawbot-curator`
|
|
9
62
|
skill, a local
|
|
10
63
|
`weclawbot_validate_screen_document` tool, a `weclawbot_validate_activity`
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openbrt/weclawbotctl",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "WeClawBot
|
|
3
|
+
"version": "0.1.3",
|
|
4
|
+
"description": "WeClawBot pairing and screen-control CLI for local AI agents.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"keywords": [
|
|
@@ -10,7 +10,11 @@
|
|
|
10
10
|
"esp32",
|
|
11
11
|
"e-paper",
|
|
12
12
|
"openclaw",
|
|
13
|
-
"agent"
|
|
13
|
+
"agent",
|
|
14
|
+
"codex",
|
|
15
|
+
"claude-code",
|
|
16
|
+
"gemini-cli",
|
|
17
|
+
"hermes"
|
|
14
18
|
],
|
|
15
19
|
"engines": {
|
|
16
20
|
"node": ">=20"
|