@openbrt/weclawbotctl

Generic WeClawBot pairing and screen-control CLI for local AI assistants.

Use it from OpenClaw, Antigravity, Hermes, Codex, Claude Code, Gemini CLI, OpenCode, or any shell/script environment that can install npm packages and run commands. This package is not a host-specific plugin and does not install Agent plugins.

Tell Your Agent

Install the npm tool @openbrt/weclawbotctl in your current AI assistant environment, then bind my WeClawBot screen with pairing code 123456. Only install this npm tool; do not install any extra plugin.

Replace 123456 with the six-digit code shown on the screen.

Install And Bind

npm install -g @openbrt/weclawbotctl
weclawbotctl bind 123456 --name antigravity
weclawbotctl doctor --online --timeout 8

One-shot usage without a global install:

npm exec --package @openbrt/weclawbotctl -- weclawbotctl bind 123456 --name antigravity
npm exec --package @openbrt/weclawbotctl -- weclawbotctl doctor --online --timeout 8

The bind command stores MQTT credentials at ~/.config/weclawbot/agent-mqtt.json by default.

Commands

weclawbotctl status [--json]
weclawbotctl doctor [--online] [--json] [--timeout seconds]
weclawbotctl export [--format env|json|mosquitto] [--include-secret] [--output file]
weclawbotctl unbind --yes
weclawbotctl thinking [--ttl seconds] [--id correlation-id]
weclawbotctl idle [--id correlation-id]
weclawbotctl preview /path/to/screen-document.json
weclawbotctl screen /path/to/screen-document.json
weclawbotctl clear

Run weclawbotctl doctor --online --timeout 8 before expensive rendering or publishing work. If it returns credential_revoked_or_not_current_owner, the screen has been paired to another Agent and this Agent must stop.

Screen Documents

weclawbotctl screen accepts weclawbot.screen_document.v1 JSON. The mono1 bit rule is 1=black ink, 0=white paper. Default content should be white paper with black text unless the user explicitly asks for inverted, night, or poster-like black backgrounds.

weclawbotctl preview writes PNG previews of the exact packed pages so the Agent can show the user what will appear on the physical display.