Files
Dirigent/docs/INTEGRATION.md

69 lines
1.7 KiB
Markdown

# WhisperGate Integration (No-touch Template)
This guide **does not** change your current OpenClaw config automatically.
It only generates a JSON snippet you can review.
## Generate config snippet
```bash
node scripts/render-openclaw-config.mjs \
/absolute/path/to/WhisperGate/plugin \
openai \
whispergate-no-reply-v1 \
561921120408698910
```
Arguments:
1. plugin path
2. provider alias
3. model name
4. bypass user ids (comma-separated, optional)
## Output
The script prints JSON for:
- `plugins.load.paths`
- `plugins.entries.whispergate.config`
You can merge this snippet manually into your `openclaw.json`.
## Installer script (with rollback)
For production-like install with automatic rollback on error:
```bash
./scripts/install-whispergate-openclaw.sh --install
```
Uninstall (revert all recorded config changes):
```bash
./scripts/install-whispergate-openclaw.sh --uninstall
# or specify a record explicitly
# RECORD_FILE=~/.openclaw/whispergate-install-records/whispergate-YYYYmmddHHMMSS.json \
# ./scripts/install-whispergate-openclaw.sh --uninstall
```
Environment overrides:
- `PLUGIN_PATH`
- `NO_REPLY_PROVIDER_ID`
- `NO_REPLY_MODEL_ID`
- `NO_REPLY_BASE_URL`
- `NO_REPLY_API_KEY`
- `BYPASS_USER_IDS_JSON`
- `END_SYMBOLS_JSON`
The script:
- writes via `openclaw config set ... --json`
- creates config backup first
- restores backup automatically if any install step fails
- writes a change record for every install/uninstall:
- directory: `~/.openclaw/whispergate-install-records/`
- latest pointer: `~/.openclaw/whispergate-install-record-latest.json`
## Notes
- Keep no-reply API bound to loopback/private network.
- If you use API auth, set `AUTH_TOKEN` and align provider apiKey usage.