fix(docs): add --tui to the remote-gateway command#38260
Open
andyching168 wants to merge 1 commit into
Open
Conversation
Update the remote dashboard example to pass --tui and adjust the session resume icon reference in the web dashboard docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Updates the Desktop remote backend setup documentation to include the required
--tuiflag when launchinghermes dashboard.Without
--tui, the remote dashboard can pass the/api/statusreadiness check, but the Desktop app may not proceed after loggingRemote Hermes backend is ready. Starting the remote backend with--tuienables the PTY-backed TUI mode expected by the Desktop app.Related Issue
No related issue.
Type of Change
Changes Made
--tui.Changed:
to:
How to Test
Connect to it from the Hermes Desktop app.
Verify that the Desktop app connects successfully after the backend readiness check.
I also verified the failure mode before this documentation change: without
--tui, the backend returned200 OKfrom/api/status, but the Desktop app stopped after logging:Checklist
Code
fix(scope):,feat(scope):, etc.)pytest tests/ -qand all tests passDocumentation & Housekeeping
docs/, docstrings) — or N/Acli-config.yaml.exampleif I added/changed config keys — or N/ACONTRIBUTING.mdorAGENTS.mdif I changed architecture or workflows — or N/AScreenshots / Logs
Before adding
--tui, the remote backend readiness check succeeded, but the Desktop app stopped after:After starting the remote backend with:
the Desktop app was able to connect successfully.