docs: add tool_progress_overrides to configuration reference (#6364)
Documents the per-platform tool_progress_overrides config key added in PR #6348. Shows example YAML with Signal set to 'off' while Telegram stays on 'verbose'. Lists all valid platform keys.
This commit is contained in:
@@ -809,6 +809,7 @@ This controls both the `text_to_speech` tool and spoken replies in voice mode (`
|
||||
display:
|
||||
tool_progress: all # off | new | all | verbose
|
||||
tool_progress_command: false # Enable /verbose slash command in messaging gateway
|
||||
tool_progress_overrides: {} # Per-platform overrides (see below)
|
||||
skin: default # Built-in or custom CLI skin (see user-guide/features/skins)
|
||||
personality: "kawaii" # Legacy cosmetic field still surfaced in some summaries
|
||||
compact: false # Compact output mode (less whitespace)
|
||||
@@ -829,6 +830,21 @@ display:
|
||||
|
||||
In the CLI, cycle through these modes with `/verbose`. To use `/verbose` in messaging platforms (Telegram, Discord, Slack, etc.), set `tool_progress_command: true` in the `display` section above. The command will then cycle the mode and save to config.
|
||||
|
||||
### Per-platform progress overrides
|
||||
|
||||
Different platforms have different verbosity needs. For example, Signal can't edit messages, so each progress update becomes a separate message — noisy. Use `tool_progress_overrides` to set per-platform modes:
|
||||
|
||||
```yaml
|
||||
display:
|
||||
tool_progress: all # global default
|
||||
tool_progress_overrides:
|
||||
signal: 'off' # silence progress on Signal
|
||||
telegram: verbose # detailed progress on Telegram
|
||||
slack: 'off' # quiet in shared Slack workspace
|
||||
```
|
||||
|
||||
Platforms without an override fall back to the global `tool_progress` value. Valid platform keys: `telegram`, `discord`, `slack`, `signal`, `whatsapp`, `matrix`, `mattermost`, `email`, `sms`, `homeassistant`, `dingtalk`, `feishu`, `wecom`.
|
||||
|
||||
## Privacy
|
||||
|
||||
```yaml
|
||||
|
||||
Reference in New Issue
Block a user