jvsclaw-connector
v0.0.2
Published
JVSClaw official channel plugin for OpenClaw
Maintainers
Readme
jvsclaw-connector
Official JVSClaw channel plugin for OpenClaw AI agents, enabling real-time communication with users through JVSClaw enterprise IM.
Features
- QR Code Login: Display a QR code in the terminal and scan with the JVSClaw App to complete login
- Real-time Messaging: WebSocket-based message reception, no webhook HTTP server needed
- Streaming Output: Supports chunked streaming replies with
exmetadata protocol - Media Support: Images, videos, audio, files (inbound + outbound)
- Multi-account: Supports multiple JVSClaw accounts under
channels.jvsclaw.accounts
Quick Start
One-click Install & Login
Option A: npx (no global install)
npx -y jvsclaw-connectorOption B: global install
npm install -g jvsclaw-connector
jvsclawOption C: install from local tarball
npm install -g ./jvsclaw-connector-0.0.2.tgz
jvsclawCLI Options
| Option | Description | Default |
|--------|-------------|---------|
| --wy-uis-url <url> | QR code URL prefix | https://jvsclaw.aliyun.com |
| --wy-agent-url <url> | AppStream API endpoint | appstream-center.aliyuncs.com |
| --avatar-url <url> | Agent instance avatar URL | Alibaba default avatar |
| --force | Force re-login even if already authenticated | false |
Using in OpenClaw
After installation, enable the jvsclaw channel in the OpenClaw Web UI.
After running jvsclaw, apiAddr and wsAddr will be auto-populated.
Note: enable is controlled by plugins.entries.jvsclaw.enabled in openclaw.json, not in the channel config above.
Tech Stack
- Language: TypeScript
- Runtime: Node.js >= 22
- SDK:
@openim/node-client-sdk,@alicloud/appstream-center
jvsclaw-connector (中文)
JVSClaw 官方通道插件,支持 OpenClaw AI 智能体通过 JVSClaw 企业 IM 与用户实时通信。
功能特性
- 扫码登录:终端展示二维码,使用 JVSClaw App 扫码即可完成登录
- 实时消息:基于 WebSocket 接收消息,无需 webhook HTTP 服务器
- 流式输出:支持 chunked 流式回复,带有
ex元数据协议 - 媒体支持:图片、视频、音频、文件(入站 + 出站)
- 多账号:支持
channels.jvsclaw.accounts下配置多个 JVSClaw 账号
快速开始
一键安装登录
方式 A:npx(无需全局安装)
npx -y jvsclaw-connector方式 B:全局安装
npm install -g jvsclaw-connector
jvsclaw方式 C:本地 tgz 安装
npm install -g ./jvsclaw-connector-0.0.2.tgz
jvsclawCLI 参数
| 参数 | 说明 | 默认值 |
|------|------|--------|
| --wy-uis-url <url> | 二维码 URL 前缀 | https://jvsclaw.aliyun.com |
| --wy-agent-url <url> | AppStream API 端点 | appstream-center.aliyuncs.com |
| --avatar-url <url> | Agent 实例头像 URL | 阿里默认头像 |
| --force | 强制重新登录 | false |
OpenClaw 中使用
安装完成后,在 OpenClaw Web UI 中启用 jvsclaw 通道即可。
运行 jvsclaw 后,apiAddr 和 wsAddr 会自动填充。
注意:enable 由 openclaw.json 中的 plugins.entries.jvsclaw.enabled 控制,不在上述通道配置中。
技术栈
- 语言:TypeScript
- 运行时:Node.js >= 22
- SDK:
@openim/node-client-sdk、@alicloud/appstream-center
