@goodandready/dsh-plugin-notify
DSH 插件：用于回合完成、错误和审批的音频提示音、跨会话 Toast 通知、桌面推送和即时通讯 Webhook。
插件会安装到这里；不确定时保持 web。
npx -y @deepseek-ai/dsh plugin --profile web add github:GooDAnDReaDY/dsh-plugin-notify#d05d8cca46efce2de76b2fd7721b56074a8f5405Plugin Notify 以 @goodandready/dsh-plugin-notify 发布，当前版本为 0.3.5。Plugin Hub 会校验它的 manifest，并保存精确安装来源，便于复现安装结果。
🇬🇧 English • 🇨🇳 中文说明 • 🇷🇺 Русский
|
⭐ If you like this plugin, please star it on GitHub — it shows me that the plugin is useful to you and motivates me to keep developing it.
🐛 If you find a bug or would like to request a feature, open a GitHub issue in any language — I will review your proposal and implement useful suggestions in a future plugin version. |
DeepSeek Harness already knows when a turn finished, failed, or is waiting for approval. Without this plugin, those events remain confined inside the session. If you are working across multiple parallel sessions or minimized in another app, you have to keep manually checking back.
This plugin bridges that gap across four flexible notification layers:
Notification API with window focus and session switching on click.graph TD
A[DSH session/event] --> B[plugin-notify host]
B -->|credential name| C[Credentials service]
C -->|webhook URL| B
B -->|POST JSON| D[Feishu / WeCom / DingTalk / Slack / Discord / custom]
B -.->|macOS only| E[osascript notification]
B -->|SSE stream: /dsh-plugin-notify/events| F[Client Listener lib/client.js]
F -->|Web Audio API| G[Audio Chimes]
F -->|DOM overlay| H[Cross-Session Toasts]
F -->|Notification API| I[Desktop / OS Push]
J[Settings Card] -->|configuration| B
lib/index.js)session/event.turn/end with reason.kind === 'completed' → task_done.turn/end with any other reason → error.approval/asked → approval_requested.GET /dsh-plugin-notify/events) on the Cordis webServer service.webhooks.* value as: legacy http(s):// URL (deprecated warning) → Credentials resolve(credentialRef(name)) → process.env[name].AbortSignal.timeout(timeoutMs) (default 5000 ms). Failed POSTs are logged and never retried, and they never block the agent loop.HH:MM, including overnight ranges). Events are still observed; webhooks, chimes, and local popups are skipped.excludeSessionPrefixes skips sessions whose id starts with a configured prefix.lib/client.js)settings.plugin.item.task_done, error, and approval_requested with interactive "Test sound" button.notifyBackgroundOnly filter.loading / unavailable / ready before the form is writable.en and zh only. Russian UI is supplied at runtime by dsh-russian-lang.data-dsh-plugin="dsh-plugin-notify".Install via the DSH web profile:
dsh plugin --profile web add @goodandready/dsh-plugin-notify
Restart the web profile so the client half loads. Then open Settings → Plugins → Notify.
Put each webhook URL into Settings → Credentials. In the plugin card, type only the credential name.
- id: plugin-notify
name: '@goodandready/dsh-plugin-notify'
config:
enableSound: false
enableToasts: false
enableDesktopNotifications: false
notifyBackgroundOnly: false
webhooks:
feishu: NOTIFY_FEISHU_WEBHOOK
wecom: NOTIFY_WECOM_WEBHOOK
dingtalk: NOTIFY_DINGTALK_WEBHOOK
slack: NOTIFY_SLACK_WEBHOOK
discord: NOTIFY_DISCORD_WEBHOOK
custom: NOTIFY_CUSTOM_WEBHOOK
events: [task_done, error, approval_requested]
local: true
timeoutMs: 5000
dnd:
start: ''
end: ''
includeSession: true
includeDuration: true
excludeSessionPrefixes: []
| Parameter | Type | Default | Description |
|---|---|---|---|
enableSound | boolean | false | Synthesize gentle Web Audio chimes on turn finish, error, or approval wait (opt-in). |
enableToasts | boolean | false | Show cross-session on-screen banner toasts with interactive session switching (opt-in). |
enableDesktopNotifications | boolean | false | Show native OS push notifications via HTML5 Notification API (opt-in). |
notifyBackgroundOnly | boolean | false | Only trigger audio, toasts, and push when event is from an inactive/background session. |
webhooks.* | string | empty | Credential name whose value is the webhook URL. Empty disables the channel. |
events | string[] | task_done, error, approval_requested | Event whitelist. Empty restores the default three. |
local | boolean | true | macOS osascript popup; ignored on other platforms. |
timeoutMs | number | 5000 | Per-request abort timeout. |
dnd.start / dnd.end | string | empty | HH:MM window. Equal or invalid values disable DND. |
includeSession | boolean | true | Append Session: … to the text body. |
includeDuration | boolean | true | Append Duration: … when a turn start timestamp is known. |
excludeSessionPrefixes | string[] | [] | Skip notifications when session.id starts with any prefix. |
A leftover raw http(s):// value in webhooks.* still posts, with a deprecation warning. Migrate it to Credentials.
| Channel | JSON body |
|---|---|
| Feishu | { msg_type: 'text', content: { text } } |
| WeCom | { msgtype: 'text', text: { content: text } } |
| DingTalk | { msgtype: 'text', text: { content: text } } |
| Slack | { text } |
| Discord | { content: text } |
| custom | { text, kind, title, sessionId, durationMs, time } |
Text body:
【Task done】short session title
Summary: …
Reason: completed
Duration: 3m 42s
Session: session-1
From a clone:
npm install --no-audit --no-fund --no-package-lock
npm test
pretest runs node --check on lib/index.js and lib/client.js. npm test then runs node --test test/*.test.mjs.
The suite stubs fetch / a local HTTP listener. It does not call a real IM provider. Live delivery needs a webhook you own.
Expected output:
✔ public package identity matches host, client and patch sites
✔ client locale registration coexists with Russian language pack
✔ client apply does not register ru and can reload after effect dispose
✔ legacy raw webhook URL still posts (compat)
✔ credential ref resolves webhook URL via credentials service
✔ resolveWebhookValue prefers credentials then env
✔ missing credential name does not post
✔ each IM channel posts the expected body shape
✔ recipient HTTP failure does not throw out of the session loop
✔ AbortSignal.timeout is attached to webhook POST
✔ excluded session prefixes suppress notifications
✔ Config schema validates sound, toast, and desktop notification fields with opt-in defaults
✔ SSE route registers on webServer, rejects untrusted requests, and handles trusted stream
✔ client does not register settings.section slot (issue #16 fix)
✔ deliveries and warnings are routed through ctx.logger without console calls (issue #22 fix)
ℹ tests 15
ℹ pass 15
ℹ fail 0
MIT © GooDAnDReaDY
See CHANGELOG.md for full release and version history.