From 9eb36fd6970f7675ed120cfa64eb05787ca6ef59 Mon Sep 17 00:00:00 2001 From: alt-glitch Date: Tue, 9 Jun 2026 08:35:43 +0000 Subject: [PATCH] docs: OpenTUI is the default engine on supported hosts; Ink is the fallback MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Note in the README CLI section that the terminal UI defaults to the native OpenTUI engine on Linux/macOS with Bun (provisioned by the installer), and that the legacy Ink engine remains the automatic fallback (Windows, Termux, no Bun) and can be selected explicitly with HERMES_TUI_ENGINE=ink. Ink is not removed — it's the kept fallback. No in-repo config example documents display.tui_engine (the published config reference lives on the docs site, not the repo), so there was nothing to annotate there. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2c587b81ac5..4520cc78faf 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,8 @@ You can still bring your own keys per-tool whenever you want — the gateway is Hermes has two entry points: start the terminal UI with `hermes`, or run the gateway and talk to it from Telegram, Discord, Slack, WhatsApp, Signal, or Email. Once you're in a conversation, many slash commands are shared across both interfaces. +> **TUI engine:** On supported hosts (Linux/macOS with [Bun](https://bun.sh)), the terminal UI defaults to the native **OpenTUI** engine, which the installer provisions for you. The legacy **Ink** engine remains the fallback — it's used automatically on Windows, Termux, or when Bun isn't available, and you can select it explicitly with `HERMES_TUI_ENGINE=ink hermes`. Ink is not going away; it's the kept fallback. + | Action | CLI | Messaging platforms | | ------------------------------ | --------------------------------------------- | -------------------------------------------------------------------------------- | | Start chatting | `hermes` | Run `hermes gateway setup` + `hermes gateway start`, then send the bot a message |