openclaw-yunjia-cli
v0.0.3
Published
Lightweight installer for the OpenClaw Inspur Yunjia (浪潮云加) channel plugin
Downloads
394
Readme
OpenClaw 浪潮云加 CLI 安装工具
轻量级命令行工具，用于安装和配置 OpenClaw 浪潮云加 通道插件。
功能特性
- 自动检测 OpenClaw 版本并安装兼容插件
- 二维码扫码绑定，无需手动输入凭据
- 支持 SSE (Server-Sent Events) 实时推送绑定状态
- 多账户管理
- 终端友好的交互界面
快速开始
首次安装（推荐）
自动安装插件并通过扫码绑定浪潮云加账户：
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install安装完成后，插件会自动创建与用户的聊天频道并发送欢迎消息。
手动添加账户
如果已有 Bot 凭据，可以直接添加账户：
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer add-account环境检查
检查当前环境是否满足运行要求：
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer check命令详解
install
完整安装流程：检测环境 → 安装插件 → 扫码绑定 → 重启 Gateway
# 使用默认绑定服务
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install
# 指定绑定服务地址（开发环境）
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --server http://localhost:3210
# 启用详细日志
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --verbose
# 使用本地开发包安装（插件开发时使用）
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --dev-package ../openclaw-inspur-yunjia
# 组合使用（开发包 + 本地服务）
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --dev-package ../openclaw-inspur-yunjia --server http://localhost:3210命令行选项：
| 选项 | 说明 |
|------|------|
| --server <url> 或 --api-base <url> | 指定绑定服务地址 |
| --dev-package <path> | 使用本地开发包路径安装插件 |
| --verbose, -v | 显示详细日志输出 |
add-account
手动添加浪潮云加账户（需已安装插件）
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer add-account交互式输入：
- Bot ID
- Bot Secret
- 企业名称（可选）
- 账户 ID（可选，默认 "default"）
check
检查当前环境是否满足运行要求
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer check检查项：
- Node.js 版本（>= 20）
- OpenClaw 是否已安装
- 浪潮云加插件是否已安装
help
显示帮助信息
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer help安装流程
二维码扫码绑定流程
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ CLI 工具 │ ───▶ │ 绑定服务端 │ ◀─── │ 浪潮云加 │
│ │ │ │ │ 客户端 │
└─────────────┘ └─────────────┘ └─────────────┘
│ │ │
│ 1. 请求二维码 │ │
│ ─────────────────▶ │ │
│ │ │
│ 2. 返回二维码URL │ │
│ ◀───────────────── │ │
│ │ │
│ 3. 显示二维码 │ │
│ │ │
│ │ 4. 用户扫码 │
│ │ ◀────────────────── │
│ │ │
│ 5. SSE: scanned │ │
│ ◀───────────────── │ │
│ │ │
│ │ 6. 用户确认绑定 │
│ │ ◀────────────────── │
│ │ │
│ │ 7. 创建机器人 │
│ │ ─────────────────▶ │
│ │ │
│ 8. SSE: bound │ │
│ ◀───────────────── │ │
│ │ │
│ 9. 写入配置 │ │
│ 10. 重启 Gateway │ │详细步骤
环境检查
- 检测 OpenClaw 版本
- 根据兼容矩阵选择对应的插件版本
安装插件
- 自动安装
openclaw-inspur-yunjia插件 - 创建必要的 symlink
- 自动安装
请求二维码
- 向绑定服务请求二维码（含绑定ID）
- 二维码有效期 60 秒
显示二维码
- 在终端显示二维码
- 使用
qrcode库或系统 CLI 工具
等待用户扫码
- 通过 SSE (Server-Sent Events) 等待绑定结果
- 支持最多 3 次重试
用户扫码
- 用户使用浪潮云加客户端扫描二维码
- 收到
scanned事件，停止二维码刷新
等待用户确认
- 用户在云加客户端确认绑定
- 确认超时时间 60 秒
绑定成功
- 服务端创建机器人并返回凭据
- 通过 SSE 收到
bound事件，包含：bot_idbot_secretuser_iduser_nameenterprise
写入配置
- 将凭据写入
~/.openclaw/openclaw.json
- 将凭据写入
重启 Gateway
- 自动重启 OpenClaw Gateway
- 插件首次启动会创建聊天频道并发送欢迎消息
前置要求
| 依赖 | 最低版本 | 说明 | |------|----------|------| | Node.js | 20.0.0 | 运行时环境 | | OpenClaw | 2026.3.22 | 主程序 |
环境变量
| 变量 | 默认值 | 说明 |
|------|--------|------|
| YUNJIA_BINDING_API_BASE | https://id.inspuronline.com | 绑定服务地址 |
| NODE_ENV | - | 设为 development 时默认绑定服务为 localhost:3210 |
时间配置
| 配置项 | 默认值 | 说明 | |--------|--------|------| | 二维码有效期 | 60 秒 | 用户扫码的时间窗口 | | 扫码后确认超时 | 60 秒 | 扫码后等待用户确认的时间 | | 最大重试次数 | 3 次 | 二维码过期后的重试次数 | | 短轮询间隔 | 5000 ms | SSE 失败降级为轮询模式时的间隔 |
配置文件
配置文件位置：~/.openclaw/openclaw.json
{
"channels": {
"openclaw-inspur-yunjia": {
"botId": "BOT-xxx",
"botSecret": "secret-xxx",
"enterprise": "企业名称",
"enabled": true,
"accounts": {
"account-1": {
"botId": "BOT-yyy",
"botSecret": "secret-yyy",
"enabled": true
}
},
"defaultAccount": "default"
}
}
}兼容性矩阵
| 插件版本 | OpenClaw 版本范围 | |----------|-------------------| | 0.1.x (latest) | >= 2026.3.22 |
常见问题
Q: 二维码过期后怎么办？
A: 工具会自动生成新的二维码，最多重试 3 次。如果 3 次都过期，请重新运行安装命令。
Q: 用户扫码后确认超时？
A: 扫码后有 60 秒时间确认绑定。如果超时，需要重新运行安装命令。
Q: 如何查看详细日志？
A: 使用 --verbose 或 -v 参数：
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --verboseQ: 如何添加多个账户？
A: 首次安装使用 install 命令，后续账户使用 add-account 命令。
Q: SSE 连接失败怎么办？
A: 如果 SSE 连接失败，工具会自动降级为短轮询模式（5 秒间隔），最多重试 3 次。
Q: 如何在开发时使用本地插件包？
A: 使用 --dev-package 参数指定本地插件路径：
# 使用相对路径
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --dev-package ../openclaw-inspur-yunjia
# 使用绝对路径
npx -y @inspur-ccs/openclaw-inspur-yunjia-installer install --dev-package /home/user/projects/openclaw-inspur-yunjia如果插件已安装，工具会询问是否重新安装开发包。
开发
插件开发工作流
在开发 openclaw-inspur-yunjia 插件时，可以使用本地开发包进行测试：
# 假设项目目录结构：
# /projects/
# ├── openclaw-inspur-yunjia/ # 插件源码
# ├── openclaw-inspur-yunjia-cli/ # CLI 工具
# └── openclaw-inspur-yunjia-binding-server/ # 绑定服务
# 1. 在插件目录进行开发
cd ../openclaw-inspur-yunjia
# ... 修改插件代码 ...
# 2. 使用 CLI 工具安装本地开发包
cd ../openclaw-inspur-yunjia-cli
npx -y . install --dev-package ../openclaw-inspur-yunjia --server http://localhost:3210开发模式特性：
- 自动将相对路径转换为绝对路径
- 验证路径是否存在且包含
package.json - 如果插件已安装，会提示是否重新安装
- 支持与
--server参数组合使用
本地测试 CLI 工具
# 克隆仓库
git clone https://github.com/openclaw/openclaw-inspur-yunjia-cli.git
cd openclaw-inspur-yunjia-cli
# 运行
node cli.mjs install --server http://localhost:3210绑定服务
绑定服务源码：openclaw-inspur-yunjia-binding-server
License
Inspur CCS - 浪潮云加技术团队