Skip to content

docs(gateway): document progress cleanup setting #21610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
helix4u wants to merge 1 commit into from
Closed

docs(gateway): document progress cleanup setting #21610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions website/docs/user-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1167,6 +1167,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
cleanup_progress: false # Gateway: delete temporary progress/status bubbles after successful final delivery
platforms: {} # Per-platform display overrides (see below)
tool_progress_overrides: {} # DEPRECATED — use display.platforms instead
interim_assistant_messages: true # Gateway: send natural mid-turn assistant updates as separate messages
Expand Down Expand Up @@ -1205,6 +1206,22 @@ 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.

### Progress cleanup (gateway only)

When `display.cleanup_progress: true`, Hermes keeps live progress visible during long gateway turns, then deletes temporary progress/status bubbles after the final response is delivered successfully. This covers tool-progress bubbles, long-running "Still working..." notices, and context-pressure status messages.

Cleanup is best-effort and only works on adapters that support message deletion. Today that mainly means Telegram. Failed runs skip cleanup so the progress bubbles remain as breadcrumbs for debugging.

You can set this globally or per platform:

```yaml
display:
cleanup_progress: false
platforms:
telegram:
cleanup_progress: true
```

### Runtime-metadata footer (gateway only)

When `display.runtime_metadata_footer: true`, Hermes appends a small runtime-context footer to the **final** message of each gateway turn — same info the CLI shows in its status bar (model, session duration, tokens, cost). Off by default; opt in per-gateway if your team wants every reply to include the provenance.
Expand Down Expand Up @@ -1234,6 +1251,7 @@ display:
tool_progress: 'off' # silence progress on Signal
telegram:
tool_progress: verbose # detailed progress on Telegram
cleanup_progress: true # delete temporary progress/status bubbles after success
slack:
tool_progress: 'off' # quiet in shared Slack workspace
```
Expand Down
Loading