@boxie/boxie-openclaw
v0.1.4
Published
OpenClaw adapter for Boxie local bridge
Maintainers
Readme
boxie-openclaw
Boxie 的 OpenClaw 侧适配包。它会把 Boxie 作为一个 OpenClaw plugin 装进本地环境,并提供配套 CLI:
- plugin:给 OpenClaw 注册
boxie_bridgetool - skill:提示模型在需要时使用 Boxie
- command:提供更稳定的
/boxie ...直连入口 - CLI:用于
install / configure / doctor / chat / service
安装:
npx -y --package @boxie/boxie-openclaw boxie-openclaw install推荐接入顺序:
npx -y --package @boxie/boxie-openclaw boxie-openclaw install
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js configure --base-url "http://127.0.0.1:31808/api/v2/openclaw/chat" --token "<Boxie Bridge Token>"
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js doctor接入成功后,推荐在 OpenClaw 里优先使用:
/boxie 帮我安排今晚的任务这个命令会直接走 Boxie bridge,比纯自然语言触发更稳定。
CLI 命令
这个包当前提供这些命令:
install- 安装本地运行脚本到
~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js - 安装 OpenClaw plugin 到
~/.openclaw/extensions/boxie-openclaw - 写入
~/.openclaw/openclaw.json中的 plugin 安装记录和配置壳 - 同时保留一份兼容配置
~/.openclaw/boxie-openclaw.json - 安装期可设置 Boxie OpenClaw 本地桥端口、OpenClaw 端口,并引导启用本机常驻服务
- 安装本地运行脚本到
configure- 单独写入 Boxie 本地 Bridge 地址与 Token
- 支持交互式输入,或通过参数传入
- 配置完成后会自动把本地 companion service 地址回写到 Boxie
chat- 将一条 OpenClaw 消息转发到 Boxie 本地 Bridge
- 只输出 Boxie 最终回复文本,适合直接给 OpenClaw skill 使用
doctor- 检查 Boxie Bridge、Boxie OpenClaw companion service、Token 和 LLM 是否可用
service- 手动启动 Boxie OpenClaw 本地 companion service
show-config- 打印当前本地适配配置
示例:
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js chat \
--message "帮我安排今天晚上的任务" \
--channel lark \
--sender lucas如果你已经在 Boxie 设置页里点击了“复制接入配置”,复制出来的应该就是下面这种 configure 命令:
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js configure \
--base-url "http://127.0.0.1:31808/api/v2/openclaw/chat" \
--token "<Boxie Bridge Token>"接入完成后,建议先跑一次:
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js doctor如果已经安装但本机常驻服务没有起来,也可以手动启动:
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js service说明:
- 安装阶段仍然推荐使用
npx,因为这是第一次把脚本和 plugin 写入本地。 - 安装完成后,推荐统一调用
node ~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js ...。 - 这样可以避免 scoped npm 包在部分环境里出现命令解析不稳定的问题,也不依赖你本地是否把脚本目录加入了 PATH。
正常情况下会返回一段 JSON,告诉你:
- Bridge 是否已启用
- 当前 token 是否有效
- Boxie 的 LLM 是否已配置并可用
- companion service 是否已启动
- OpenClaw gateway 与可用 channels 是否正常
如果你当前运行的是稍早一点的 Boxie 本地版本,doctor 也会自动回退到兼容检查,不会因为缺少新的 health 接口就直接失败。
本地文件
兼容配置文件:
~/.openclaw/boxie-openclaw.json
OpenClaw 主配置:
~/.openclaw/openclaw.json
插件目录:
~/.openclaw/extensions/boxie-openclaw
本地运行脚本:
~/.openclaw/boxie-openclaw/bin/boxie-openclaw.js
默认 Boxie Bridge 地址:
http://127.0.0.1:31808/api/v2/openclaw/chat
