docs: add sample config and verification guide

This commit is contained in:
2026-02-25 10:37:12 +00:00
parent 7728892d15
commit e020f1f026
2 changed files with 58 additions and 0 deletions

28
docs/CONFIG.example.json Normal file
View File

@@ -0,0 +1,28 @@
{
"plugins": {
"load": {
"paths": ["/path/to/WhisperGate/plugin"]
},
"entries": {
"whispergate": {
"enabled": true,
"config": {
"enabled": true,
"discordOnly": true,
"bypassUserIds": ["561921120408698910"],
"endSymbols": ["。", "", "", ".", "!", "?"],
"noReplyProvider": "openai",
"noReplyModel": "whispergate-no-reply-v1"
}
}
}
},
"models": {
"providers": {
"openai": {
"apiKey": "sk-xxxx",
"baseURL": "http://127.0.0.1:8787/v1"
}
}
}
}

30
docs/VERIFY.md Normal file
View File

@@ -0,0 +1,30 @@
# WhisperGate Quick Verification
## 1) Start no-reply API
```bash
cd no-reply-api
npm start
```
## 2) Validate API behavior
```bash
curl -sS http://127.0.0.1:8787/health
curl -sS -X POST http://127.0.0.1:8787/v1/chat/completions \
-H 'Content-Type: application/json' \
-d '{"model":"whispergate-no-reply-v1","messages":[{"role":"user","content":"hi"}]}'
```
Expected assistant text: `NO_REPLY`
## 3) Enable plugin
Set OpenClaw plugin path to `plugin/` and apply `docs/CONFIG.example.json` values.
## 4) Discord logic check
- non-discord session -> normal model
- discord + bypass user -> normal model
- discord + non-bypass + ending punctuation -> normal model
- discord + non-bypass + no ending punctuation -> no-reply model override