TUI & Desktop from Worktrees
تطوير الواجهات من Worktrees
What this page is, and what it holds.
This page covers TUI & Desktop from Worktrees. It carries a source warning and takes about 5 minutes to read. Read what the installer does before running it, then run hermes doctor to see what is missing.
Run the Ink TUI and Electron desktop app from a git worktree without a full npm install per checkout
Outcomes taken from this page, not a template.
- Understand what التثبيت is and when you need it.
- Read the table and take only the row that applies to you.
- Set
HERMES_MAIN_CHECKOUTin the right place. - Avoid the mistake the source warns about.
Exactly as they appear in Hermes.
HERMES_MAIN_CHECKOUTHERMES_TUI_DIRHERMES_GUI_DEPS_CHECKOUTHERMES_DESKTOP_HERMES_ROOTHERMES_DESKTOP_PYTHONHERMES_DESKTOP_IGNORE_EXISTINGHERMES_DESKTOP_CWD
Jump to the part you need.
Nothing summarised away.
The documentation body below is reproduced from the official source so commands and identifiers stay exact. Each section carries a short note describing what it contains.
The Python core runs fine from any git worktree — cd in and hermes just works. The two TypeScript surfaces do not: ui-tui/ and apps/desktop/ each need a populated node_modules, and a fresh npm ci per worktree is slow and duplicates gigabytes across every branch you have checked out.
htui and hgui are two shell helpers that close that gap. Each launches its surface from the current worktree while borrowing node_modules from one canonical checkout — so a throwaway branch costs a symlink, not an install.
They're developer conveniences, not shipped commands. Drop them in ~/.zshrc; adapt paths to taste.
The deps-sharing model
Explains the idea itself. Read it slowly; the later sections build on it.
One checkout is the deps checkout — the one place you actually run npm install. Every other worktree links against it, and only re-installs locally when its lockfile diverges (a branch that bumps a dependency must not silently run against stale packages).
flowchart TD
A[htui / hgui in a worktree] --> B{package-lock.json<br/>matches deps checkout?}
B -- yes --> C[symlink node_modules<br/>from deps checkout]
B -- no --> D[local npm ci<br/>in this worktree]
C --> E[launch surface]
D --> ETwo env vars name the canonical checkout:
| Variable | Meaning |
|---|---|
HERMES_MAIN_CHECKOUT | The deps checkout — where node_modules really lives, and whose .venv/bin/python runs the backend. |
HERMES_GUI_DEPS_CHECKOUT | Where the desktop deps (apps/desktop/node_modules) live. Defaults to HERMES_MAIN_CHECKOUT; override only if you keep desktop deps elsewhere. |
Neither is read by Hermes itself — they're private to these helpers. The variables Hermes does read are covered in Environment Variables.
`htui` — TUI from the worktree
Carries a warning. Read it before running anything here. The upstream warning appears below.
The Ink TUI has a dev path already: hermes --tui --dev runs the TypeScript sources via tsx instead of the prebuilt bundle. htui is a one-liner over it that also points the run at the current worktree's ui-tui/:
htui() {
local root
root="$(_hermes_root)" || { echo "htui: not in a Hermes checkout" >&2; return 1; }
( cd "$root" && PYTHONPATH="$root" \
"$HERMES_MAIN_CHECKOUT/.venv/bin/python" -m hermes_cli.main --tui --dev "$@" )
}--dev compiles from source, so it links ui-tui/node_modules from HERMES_MAIN_CHECKOUT when the root lockfile matches and installs locally otherwise (see _hermes_root / linking helpers ↗).
`hgui` — desktop app from the worktree
A lookup table. Do not read it all; find the row that applies to you.
The desktop app is heavier: it needs node_modules at both the repo root and apps/desktop/, a Vite dev server pinned to port 5174, and a Python backend. hgui wires all of it against the current worktree:
hgui() {
local root deps desktop
root="$(_hermes_root)" || { echo "hgui: not in a Hermes checkout" >&2; return 1; }
deps="${HERMES_GUI_DEPS_CHECKOUT:-$HERMES_MAIN_CHECKOUT}"
desktop="$root/apps/desktop"
# Borrow deps when locks match; otherwise install locally in the worktree.
if cmp -s "$root/package-lock.json" "$deps/package-lock.json"; then
_hermes_link_deps "$desktop" "$deps/apps/desktop"
_hermes_link_deps "$root" "$deps"
else
( cd "$root" && npm ci ) || return 1
fi
# Vite is fixed at 5174 — evict a stale session from another hgui.
lsof -t -i:5174 >/dev/null 2>&1 && killport 5174
# Electron often survives Ctrl+C without reaping its ephemeral backends.
trap '_hermes_gui_cleanup "$root"' INT TERM EXIT
( cd "$desktop"
export PATH="$root/node_modules/.bin:$PATH"
HERMES_DESKTOP_HERMES_ROOT="$root" \
HERMES_DESKTOP_PYTHON="$HERMES_MAIN_CHECKOUT/.venv/bin/python" \
HERMES_DESKTOP_IGNORE_EXISTING=1 \
HERMES_DESKTOP_CWD="$root" \
npm run dev )
}The desktop env vars it sets are all real backend-resolution knobs:
| Variable | Role in hgui |
|---|---|
HERMES_DESKTOP_HERMES_ROOT | Runs the backend from this worktree, not the packaged/PATH hermes. |
HERMES_DESKTOP_PYTHON | Reuses the deps checkout's venv instead of re-resolving a Python. |
HERMES_DESKTOP_IGNORE_EXISTING | Ignores any hermes on PATH so it can't shadow the worktree. |
HERMES_DESKTOP_CWD | Opens the desktop chat rooted at the worktree. |
Two footguns hgui handles that a bare npm run dev does not:
- Port
5174is fixed. A secondhguicollides with the first's Vite server; the helper kills the stale one first. - Orphaned children. Electron frequently survives
Ctrl+Cthroughconcurrentlywithout reaping the ephemeraldashboard --port 0backend or the Vite process. TheEXIT/INT/TERMtrap runs a cleanup that terminates the Electron shell, the:5174listener, and any--port 0dashboard it spawned.
See also
Settings you configure once. Change one at a time so you can see what each does. Set HERMES_TUI_DIR in your environment, not in the chat.
- Git Worktrees — the isolation model these helpers build on
- TUI —
hermes --tui --devand theHERMES_TUI_DIRprebuild path - Desktop App — building from source and the backend resolution ladder
apps/desktop/README.md↗ — dev server, sandbox script, and packaging- Environment Variables — every
HERMES_*variable Hermes reads
4 questions answered by this page alone.
Every option is a real identifier from the Hermes documentation. The wrong ones are real too, just from other pages.