Skip to content

fix(docs): add --tui to the remote-gateway command#38260

Open
andyching168 wants to merge 1 commit into
NousResearch:mainfrom
andyching168:main
Open

fix(docs): add --tui to the remote-gateway command#38260
andyching168 wants to merge 1 commit into
NousResearch:mainfrom
andyching168:main

Conversation

@andyching168

@andyching168 andyching168 commented Jun 3, 2026

Copy link
Copy Markdown

What does this PR do?

Updates the Desktop remote backend setup documentation to include the required --tui flag when launching hermes dashboard.

Without --tui, the remote dashboard can pass the /api/status readiness check, but the Desktop app may not proceed after logging Remote Hermes backend is ready. Starting the remote backend with --tui enables the PTY-backed TUI mode expected by the Desktop app.

Related Issue

No related issue.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Security fix
  • Documentation update
  • Tests (adding or improving test coverage)
  • Refactor (no behavior change)
  • New skill (bundled or hub)

Changes Made

  • Updated the documented Desktop remote backend command to include --tui.
  • Clarified the command needed when connecting Hermes Desktop to a remote backend.

Changed:

hermes dashboard --no-open --insecure --host 0.0.0.0 --port 9119

to:

hermes dashboard --tui --no-open --insecure --host 0.0.0.0 --port 9119

How to Test

  1. Start a remote Hermes backend with:
hermes dashboard --tui --no-open --insecure --host 0.0.0.0 --port 9119
  1. Connect to it from the Hermes Desktop app.

  2. 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 returned 200 OK from /api/status, but the Desktop app stopped after logging:

[hermes] [boot] Resolving Hermes backend
[hermes] [boot] Connecting to remote Hermes backend at http://100.79.130.70:9119
[hermes] [boot] Remote Hermes backend is ready

Checklist

Code

  • I've read the Contributing Guide
  • My commit messages follow Conventional Commits (fix(scope):, feat(scope):, etc.)
  • I searched for existing PRs to make sure this isn't a duplicate
  • My PR contains only changes related to this fix/feature (no unrelated commits)
  • I've run pytest tests/ -q and all tests pass
  • I've added tests for my changes (required for bug fixes, strongly encouraged for features)
  • I've tested on my platform: macOS, remote backend on Linux over Tailscale

Documentation & Housekeeping

  • I've updated relevant documentation (README, docs/, docstrings) — or N/A
  • I've updated cli-config.yaml.example if I added/changed config keys — or N/A
  • I've updated CONTRIBUTING.md or AGENTS.md if I changed architecture or workflows — or N/A
  • I've considered cross-platform impact (Windows, macOS) per the compatibility guide — or N/A
  • I've updated tool descriptions/schemas if I changed tool behavior — or N/A

Screenshots / Logs

Before adding --tui, the remote backend readiness check succeeded, but the Desktop app stopped after:

[hermes] [boot] Resolving Hermes backend
[hermes] [boot] Connecting to remote Hermes backend at http://100.79.130.70:9119
[hermes] [boot] Remote Hermes backend is ready

After starting the remote backend with:

hermes dashboard --tui --no-open --insecure --host 0.0.0.0 --port 9119

the Desktop app was able to connect successfully.

Update the remote dashboard example to pass --tui and adjust the
session resume icon reference in the web dashboard docs.
@alt-glitch alt-glitch added type/docs Documentation improvements P3 Low — cosmetic, nice to have comp/tui Terminal UI (ui-tui/ + tui_gateway/) labels Jun 3, 2026
@andyching168 andyching168 changed the title docs fix: add --tui to the remote-gateway command fix(docs): add --tui to the remote-gateway command Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp/tui Terminal UI (ui-tui/ + tui_gateway/) P3 Low — cosmetic, nice to have type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants