Skip to content

Commit 27e94df

Browse files
committed
docs: document --sound, --border, --border-color flags for wsh badge
1 parent 2df5e5e commit 27e94df

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/docs/wsh-reference.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,10 @@ Flags:
287287
- `--color string` - set the badge color (CSS color name or hex)
288288
- `--priority float` - set the badge priority (default 10; higher priority badges take precedence)
289289
- `--clear` - remove the badge from the block or tab
290-
- `--beep` - play the system bell sound when setting the badge
290+
- `--sound string` - play a sound when setting the badge. Built-in presets: `system`, `chime`, `ping`, `gentle`. Also accepts a custom `.mp3` filename from `~/.waveterm/sounds/`
291+
- `--beep` - alias for `--sound system` (plays the OS system bell)
292+
- `--border` - show a persistent border highlight on the block (clears when the block is focused)
293+
- `--border-color string` - border color override (defaults to `--color` value, then amber `#fbbf24`)
291294
- `--pid int` - watch a PID and automatically clear the badge when it exits (sets default priority to 5)
292295
- `-b, --block` - target a specific block or tab (same format as `getmeta`)
293296
@@ -306,9 +309,15 @@ wsh badge triangle-exclamation --color red --priority 20 -b 2
306309
# Set a badge that clears when a process exits
307310
wsh badge --pid 12345
308311
309-
# Play the bell and set a badge when done
312+
# Play the system bell and set a badge
310313
wsh badge circle-check --beep
311314
315+
# Play a chime sound and highlight the block border
316+
wsh badge circle-check --color green --sound chime --border
317+
318+
# Play a custom sound with a red border
319+
wsh badge bell --sound mysound.mp3 --border --border-color '#ef4444'
320+
312321
# Clear the badge on the current block
313322
wsh badge --clear
314323
@@ -320,6 +329,10 @@ wsh badge --clear -b tab
320329
The `--pid` flag is not supported on Windows.
321330
:::
322331
332+
:::note
333+
Custom sounds must be `.mp3` files placed in `~/.waveterm/sounds/`. Built-in presets (`system`, `chime`, `ping`, `gentle`) are always available.
334+
:::
335+
323336
---
324337
325338
## run

0 commit comments

Comments
 (0)