@ywfe/openclaw-plugin-caryscloud-im 0.0.13 → 0.1.1

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.
Files changed (3) hide show
  1. package/INTEGRATION.md +15 -15
  2. package/README.md +13 -18
  3. package/package.json +2 -1
package/INTEGRATION.md CHANGED
@@ -106,8 +106,8 @@ openclaw channels add --channel caryscloud-im \
106
106
 
107
107
  | 参数 | 说明 | 示例 |
108
108
  |------|------|------|
109
- | `--wsUrl` | WebSocket 服务器地址 | `wss://api.example.com/ws` |
110
- | `--targetUserId` | 目标用户 ID | `user123` |
109
+ | `--http-url` | WebSocket 服务器地址 | `wss://api.example.com/ws` |
110
+ | `--user-id` | 目标用户 ID | `user123` |
111
111
 
112
112
  #### 可选参数
113
113
 
@@ -115,37 +115,37 @@ openclaw channels add --channel caryscloud-im \
115
115
  |------|------|--------|
116
116
  | `--account` | 账号标识符 | `default` |
117
117
  | `--name` | 显示名称 | - |
118
- | `--authToken` | 认证令牌 | - |
119
- | `--uuid` | 设备 UUID | 自动生成 |
120
- | `--avatarUrl` | 头像 URL | - |
121
- | `--sendTestMessage` | 启用连接测试消息 | `false` |
118
+ | `--token` | 认证令牌 | - |
119
+ | `--device-name` | 设备 UUID | 自动生成 |
120
+ | `--webhook-path` | 头像 URL | - |
121
+ | `--auto-discover-channels` | 启用连接测试消息 | `false` |
122
122
 
123
123
  #### 使用示例
124
124
 
125
125
  **最简配置:**
126
126
  ```bash
127
127
  openclaw channels add --channel caryscloud-im \
128
- --wsUrl wss://api.example.com/ws \
129
- --targetUserId user123
128
+ --http-url wss://api.example.com/ws \
129
+ --user-id user123
130
130
  ```
131
131
 
132
132
  **生产环境配置:**
133
133
  ```bash
134
134
  openclaw channels add --channel caryscloud-im \
135
- --wsUrl wss://prod.example.com/ws \
136
- --targetUserId prod-user-001 \
135
+ --http-url wss://prod.example.com/ws \
136
+ --user-id prod-user-001 \
137
137
  --account production \
138
138
  --name "Production Bot" \
139
- --authToken "prod-token-xyz" \
140
- --uuid "openclaw-prod-001" \
141
- --sendTestMessage true
139
+ --token "prod-token-xyz" \
140
+ --device-name "openclaw-prod-001" \
141
+ --auto-discover-channels
142
142
  ```
143
143
 
144
144
  **开发环境配置:**
145
145
  ```bash
146
146
  openclaw channels add --channel caryscloud-im \
147
- --wsUrl ws://localhost:8080/ws \
148
- --targetUserId dev-user-001 \
147
+ --http-url ws://localhost:8080/ws \
148
+ --user-id dev-user-001 \
149
149
  --account development \
150
150
  --name "Dev Bot"
151
151
  ```
package/README.md CHANGED
@@ -2,11 +2,6 @@
2
2
 
3
3
  CarysCloud OpenClaw 的 WebSocket 频道插件 - 通过 WebSocket (wss://) 连接实现双向消息传递。
4
4
 
5
- ## 📚 文档导航
6
-
7
- - **[接入指南 (INTEGRATION.md)](./INTEGRATION.md)** - 详细的接入步骤、配置说明和服务器要求
8
- - **[README.md](./README.md)** - 本文档,功能介绍和快速开始
9
-
10
5
  ## 功能特性
11
6
 
12
7
  - ✅ 支持 wss:// 协议的 WebSocket 连接
@@ -108,34 +103,34 @@ openclaw channels add --channel caryscloud-im \
108
103
  ```
109
104
 
110
105
  **必需参数:**
111
- - `--wsUrl <url>`: WebSocket 服务器地址(必须以 ws:// 或 wss:// 开头)
112
- - `--targetUserId <id>`: 目标用户 ID
106
+ - `--http-url <url>`: WebSocket 服务器地址(必须以 ws:// 或 wss:// 开头)
107
+ - `--user-id <id>`: 目标用户 ID
113
108
 
114
109
  **可选参数:**
115
110
  - `--account <id>`: 账号标识符(默认为 "default")
116
111
  - `--name <name>`: 显示名称
117
- - `--authToken <token>`: 认证令牌
118
- - `--uuid <uuid>`: 设备 UUID
119
- - `--avatarUrl <url>`: 头像 URL
120
- - `--sendTestMessage <boolean>`: 启用连接测试消息
112
+ - `--token <token>`: 认证令牌
113
+ - `--device-name <name>`: 设备 UUID
114
+ - `--webhook-path <path>`: 头像 URL
115
+ - `--auto-discover-channels`: 启用连接测试消息
121
116
 
122
117
  **示例:**
123
118
 
124
119
  ```bash
125
120
  # 最简配置
126
121
  openclaw channels add --channel caryscloud-im \
127
- --wsUrl wss://api.example.com/ws \
128
- --targetUserId user123
122
+ --http-url wss://api.example.com/ws \
123
+ --user-id user123
129
124
 
130
125
  # 完整配置
131
126
  openclaw channels add --channel caryscloud-im \
132
- --wsUrl wss://api.example.com/ws \
133
- --targetUserId user123 \
127
+ --http-url wss://api.example.com/ws \
128
+ --user-id user123 \
134
129
  --account production \
135
130
  --name "Production Bot" \
136
- --authToken "secret-token-xyz" \
137
- --uuid "openclaw-prod-001" \
138
- --sendTestMessage true
131
+ --token "secret-token-xyz" \
132
+ --device-name "openclaw-prod-001" \
133
+ --auto-discover-channels
139
134
  ```
140
135
 
141
136
  #### 方式 2:交互式向导
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@ywfe/openclaw-plugin-caryscloud-im",
3
- "version": "0.0.13",
3
+ "version": "0.1.1",
4
4
  "description": "CarysCloud IM channel plugin for OpenClaw",
5
+ "readme": "README.md",
5
6
  "type": "module",
6
7
  "main": "./dist/index.js",
7
8
  "types": "./dist/index.d.ts",