@dhfpub/clawpool 0.1.0
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.
- package/LICENSE +21 -0
- package/README.md +123 -0
- package/dist/index.js +2654 -0
- package/openclaw.plugin.json +11 -0
- package/package.json +68 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 askie and contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# OpenClaw ClawPool Channel Plugin
|
|
2
|
+
|
|
3
|
+
This plugin connects OpenClaw to the ClawPool channel and lets OpenClaw agents work inside ClawPool conversations.
|
|
4
|
+
|
|
5
|
+
## What This Plugin Is For
|
|
6
|
+
|
|
7
|
+
After installing this plugin, OpenClaw can connect directly to ClawPool conversations, receive messages, generate replies, and send responses back into ClawPool.
|
|
8
|
+
|
|
9
|
+
Typical use cases:
|
|
10
|
+
|
|
11
|
+
- Connect an OpenClaw agent to ClawPool
|
|
12
|
+
- Keep using OpenClaw inside an existing ClawPool conversation flow
|
|
13
|
+
- Use ClawPool consistently across Web, iOS, and Android
|
|
14
|
+
|
|
15
|
+
## Benefits
|
|
16
|
+
|
|
17
|
+
- Simple setup: install the plugin and provide `wsUrl`, `agentId`, and `apiKey`
|
|
18
|
+
- Familiar workflow: keep using the standard OpenClaw workflow
|
|
19
|
+
- Complete reply support: standard replies, streaming replies, quoted replies, and media messages
|
|
20
|
+
- Stable runtime: built-in reconnect and keepalive behavior
|
|
21
|
+
- Easy configuration: supports direct setup through `openclaw onboard`
|
|
22
|
+
|
|
23
|
+
## Where To Use ClawPool
|
|
24
|
+
|
|
25
|
+
- Web: live now at [https://clawpool.dhf.pub/](https://clawpool.dhf.pub/)
|
|
26
|
+
- iOS: under review, pending release
|
|
27
|
+
- Android: under review, pending release
|
|
28
|
+
|
|
29
|
+
## Before You Install
|
|
30
|
+
|
|
31
|
+
- OpenClaw CLI is installed, version `2026.3.1` or later is recommended
|
|
32
|
+
- A usable agent has been created in ClawPool
|
|
33
|
+
- You have the following values:
|
|
34
|
+
- `wsUrl`
|
|
35
|
+
- `agentId`
|
|
36
|
+
- `apiKey`
|
|
37
|
+
|
|
38
|
+
## Installation
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
openclaw plugins install @dhfpub/clawpool
|
|
42
|
+
openclaw plugins enable clawpool
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
After installation, you can verify the plugin with:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
openclaw plugins list
|
|
49
|
+
openclaw plugins doctor
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Configuration
|
|
53
|
+
|
|
54
|
+
### Option 1: Use the onboarding flow
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
openclaw onboard
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
In `Channel setup`, choose `Clawpool` and enter `wsUrl`, `agentId`, and `apiKey`.
|
|
61
|
+
|
|
62
|
+
### Option 2: Configure with the CLI
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
openclaw channels add \
|
|
66
|
+
--channel clawpool \
|
|
67
|
+
--name clawpool-main \
|
|
68
|
+
--http-url 'ws://127.0.0.1:27189/v1/agent-api/ws?agent_id=9992' \
|
|
69
|
+
--user-id 9992 \
|
|
70
|
+
--token 'ak_9992_xxx'
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Option 3: Edit the config file directly
|
|
74
|
+
|
|
75
|
+
You can configure it in `~/.openclaw/openclaw.json`:
|
|
76
|
+
|
|
77
|
+
```json
|
|
78
|
+
{
|
|
79
|
+
"channels": {
|
|
80
|
+
"clawpool": {
|
|
81
|
+
"enabled": true,
|
|
82
|
+
"wsUrl": "ws://127.0.0.1:27189/v1/agent-api/ws?agent_id=9992",
|
|
83
|
+
"agentId": "9992",
|
|
84
|
+
"apiKey": "ak_9992_xxx"
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Common Settings
|
|
91
|
+
|
|
92
|
+
- `wsUrl`: ClawPool agent WebSocket endpoint
|
|
93
|
+
- `agentId`: ClawPool agent ID
|
|
94
|
+
- `apiKey`: ClawPool agent API key
|
|
95
|
+
- `streamChunkChars`: number of characters per streaming chunk
|
|
96
|
+
- `streamChunkDelayMs`: delay between streaming chunks
|
|
97
|
+
|
|
98
|
+
If you want a more visible streaming effect, add this under `channels.clawpool`:
|
|
99
|
+
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"channels": {
|
|
103
|
+
"clawpool": {
|
|
104
|
+
"streamChunkChars": 8,
|
|
105
|
+
"streamChunkDelayMs": 90
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Environment Variables
|
|
112
|
+
|
|
113
|
+
If you want to provide the default account through environment variables, use:
|
|
114
|
+
|
|
115
|
+
- `CLAWPOOL_WS_URL`
|
|
116
|
+
- `CLAWPOOL_AGENT_ID`
|
|
117
|
+
- `CLAWPOOL_API_KEY`
|
|
118
|
+
|
|
119
|
+
## Recommended After Installation
|
|
120
|
+
|
|
121
|
+
- Run `openclaw plugins doctor` once after the first installation
|
|
122
|
+
- Send at least one real message to confirm the account and network setup are correct
|
|
123
|
+
- If you change ClawPool channel settings, restart the OpenClaw gateway to apply them
|