@clawchatsai/connector 0.1.4 → 0.1.5
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/README.md +63 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -77,6 +77,69 @@ Config is read in priority order:
|
|
|
77
77
|
2. `~/.openclaw/openclaw.json` (OpenClaw gateway config)
|
|
78
78
|
3. `config.js` in the plugin directory (local override, gitignored)
|
|
79
79
|
|
|
80
|
+
## Development
|
|
81
|
+
|
|
82
|
+
To work on the connector locally alongside the ClawChats frontend:
|
|
83
|
+
|
|
84
|
+
### Prerequisites
|
|
85
|
+
|
|
86
|
+
- Node.js 22+
|
|
87
|
+
- OpenClaw installed and on your `PATH`
|
|
88
|
+
- The `clawchats` repo cloned at `~/clawchats` (or set `CONNECTOR_DIR` when calling its `dev.sh`)
|
|
89
|
+
|
|
90
|
+
### Build
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npm install
|
|
94
|
+
npm run build # tsc — compiles src/ → dist/
|
|
95
|
+
node esbuild.config.mjs # bundles server/ → server.js (production deploy only)
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Or use the dev script:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
./dev.sh # watch-mode tsc (recompiles on save)
|
|
102
|
+
./dev.sh --once # single build
|
|
103
|
+
./dev.sh --server # esbuild bundle (for deploy)
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Running the full stack
|
|
107
|
+
|
|
108
|
+
The connector runs as an OpenClaw plugin — it can't run standalone. Use the ClawChats dev stack to run everything together:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
# From the clawchats repo:
|
|
112
|
+
cd ~/clawchats && ./dev.sh --skip-build
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
See the ClawChats frontend repo for the full dev stack setup flow.
|
|
116
|
+
|
|
117
|
+
### Hot-reload loop
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
# Terminal 1 — watch-mode compiler
|
|
121
|
+
cd ~/connector && ./dev.sh
|
|
122
|
+
|
|
123
|
+
# Terminal 2 — full stack (no rebuild)
|
|
124
|
+
cd ~/clawchats && ./dev.sh --skip-build
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
After each tsc rebuild, reload the plugin:
|
|
128
|
+
```bash
|
|
129
|
+
openclaw --dev gateway restart
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Publishing
|
|
133
|
+
|
|
134
|
+
Releases are automated via GitHub Actions. Push a tag to trigger:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
git tag v0.1.3
|
|
138
|
+
git push origin main --tags
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
The workflow runs `npm publish` to `@clawchatsai/connector` automatically. Do not run `npm publish` manually.
|
|
142
|
+
|
|
80
143
|
## License
|
|
81
144
|
|
|
82
145
|
[AGPL-3.0-only](LICENSE) — source is open for audit and contribution.
|