AI Decision System
Replayable, offline-verifiable records for AI-assisted go/no-go decisions: experiment promotions, typed model answers and human-approved actions.
翻译准备中
Hermes WebUI:从网页或手机使用 Hermes Agent 的最佳方式!
AI 翻译
Hermes WebUI: The best way to use Hermes Agent from the web or from your phone!
取自仓库 README
正在加载完整 README。 以下为已保存的摘录。
Hermes Agent is a sophisticated autonomous agent that lives on your server, accessed via a terminal or messaging apps, that remembers what it learns and gets more capable the longer it runs.
Hermes WebUI is a lightweight, dark-themed web app interface in your browser for Hermes Agent.
Full parity with the CLI experience - everything you can do from a terminal, you can do from this UI. No build step, no framework, no bundler. Just Python and vanilla JS.查看完整 README ↗Hermes Agent is a sophisticated autonomous agent that lives on your server, accessed via a terminal or messaging apps, that remembers what it learns and gets more capable the longer it runs.
Hermes WebUI is a lightweight, dark-themed web app interface in your browser for Hermes Agent. Full parity with the CLI experience - everything you can do from a terminal, you can do from this UI. No build step, no framework, no bundler. Just Python and vanilla JS.
Layout: three-panel. Left sidebar for sessions and navigation, center for chat, right for workspace file browsing. Model, profile, and workspace controls live in the composer footer — always visible while composing. A circular context ring shows token usage at a glance. All settings and session tools are in the Hermes Control Center (launcher at the sidebar bottom).
Setup Hermes so you can access it natively on every device:
This gives you nearly 1:1 parity with Hermes CLI from a convenient web UI which you can access securely through an SSH tunnel from your Hermes setup. Single command to start this up, and a single command to SSH tunnel for access on your computer. Every single part of the web UI uses your existing Hermes agent and existing models, without requiring any additional setup.
bootstrap.py / start.sh / ctl.shMost AI tools reset every session. They don't know who you are, what you worked on, or what conventions your project follows. You re-explain yourself every time.
Hermes retains context across sessions, runs scheduled jobs while you're offline, and gets smarter about your environment the longer it runs. It uses your existing Hermes agent setup, your existing models, and requires no additional configuration to start.
What makes it different from other agentic tools:
vs. the field (landscape is actively shifting — see docs/why-hermes.md for the full breakdown):
| OpenClaw | Claude Code | Codex CLI | OpenCode | Hermes | |
|---|---|---|---|---|---|
| Persistent memory (auto) | Yes | Partial† | Partial | Partial | Yes |
| Scheduled jobs (self-hosted) | Yes | No‡ | No | No | Yes |
| Messaging app access | Yes (15+ platforms) | Partial (Telegram/Discord preview) | No | No | Yes (10+) |
| Web UI (self-hosted) | Dashboard only | No | No | Yes | Yes |
| Self-improving skills | Partial | No | No | No | Yes |
| Python / ML ecosystem | No (Node.js) | No | No | No | Yes |
| Provider-agnostic | Yes | No (Claude only) | Yes | Yes | Yes |
| Open source | Yes (MIT) | No | Yes | Yes | Yes |
† Claude Code has CLAUDE.md / MEMORY.md project context and rolling auto-memory, but not full automatic cross-session recall
‡ Claude Code has cloud-managed scheduling (Anthropic infrastructure) and session-scoped /loop; no self-hosted cron
The closest competitor is OpenClaw — both are always-on, self-hosted, open-source agents with memory, cron, and messaging. The key differences: Hermes writes and saves its own skills automatically as a core behavior (OpenClaw's skill system centers on a community marketplace); Hermes is more stable across updates (OpenClaw has documented release regressions and ClawHub has had security incidents involving malicious skills); and Hermes runs natively in the Python ecosystem. See docs/why-hermes.md for the full side-by-side.
Run the repo bootstrap:
git clone https://github.com/nesquena/hermes-webui.git hermes-webui
cd hermes-webui
python3 bootstrap.py
Or keep using the shell launcher:
./start.sh
For self-hosted VM or homelab installs, ctl.sh wraps the common daemon lifecycle commands without requiring fuser or pkill:
./ctl.sh start # background daemon, PID at ~/.hermes/webui.pid
./ctl.sh status # PID, uptime, bound host/port, log path, /health
./ctl.sh logs --lines 100 # tail ~/.hermes/webui.log
./ctl.sh restart
./ctl.sh stop
ctl.sh start runs the bootstrap in foreground/no-browser mode behind the daemon wrapper, writes logs to ~/.hermes/webui.log, and respects .env plus inline overrides such as HERMES_WEBUI_HOST=0.0.0.0 ./ctl.sh start.
Stopping the server. Each launch method has its own stop path because only
ctl.sh startwrites a PID file (~/.hermes/webui.pid):
Launch method How to stop python3 bootstrap.pyCtrl-C in the terminal (runs in the foreground) ./ctl.sh start./ctl.sh stop(sends SIGTERM, waits, then SIGKILL)Detached bootstrap.py(no--foreground) or./start.shFind the PID via lsof -i :8787(orss -tlnp) andkillit
./ctl.sh stopcannot stop a server launched bybootstrap.pyorstart.shdirectly — it only manages processes it started itself.
How chat runs by default. WebUI runs the Hermes agent in-process, reading your
HERMES_HOMEconfig directly. It does not connect to an external Hermes/agent OpenAI-compatible API server to run chat.HERMES_API_URLis only read by the Tasks/cron health probe and does not route chat.Two options if you run an external endpoint:
- Use its models as a chat provider (supported today): add it in Settings → Providers as a custom OpenAI-compatible provider with
base_url = http://127.0.0.1:8642/v1and your bearer token.- Route chat through a Hermes Gateway API server (supported today via
HERMES_WEBUI_CHAT_BACKEND=gateway): seedocs/advanced-chat-setup.md. Full agent-loop delegation is not yet shipped; tracked in #1925.
Two optional, self-hosted-deployment features — attaching dynamic session-recall prefill to browser turns (Joplin/Obsidian/Notion/llm-wiki routers), and routing browser chat through a running Hermes Gateway — are documented in docs/advanced-chat-setup.md. Most users need neither.
The bootstrap will:
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash)./health.--no-browser.Native Windows is not supported for this bootstrap yet. Use Linux, macOS, or WSL2. For Windows / WSL auto-start at login, see
docs/wsl-autostart.md.
A community-maintained native Windows setup is documented at @markwang2658/hermes-windows-native-guide (companion setup repo: @markwang2658/hermes-windows-native). Notes from the community report in #1952:
python -m venv venv → pip install -r requirements.txt → pwsh .\start.ps1 (it auto-discovers venv\Scripts\python.exe).venv/bin/python, ELF) isn't invokable by native Windows Python, so use the native setup above. WSL2 stays useful as a parallel install if you want the full bootstrap.py + Linux runtime.If provider setup is still incomplete after install, the onboarding wizard will point you to finish it with hermes model instead of trying to replicate the full CLI setup in-browser.
For a step-by-step walkthrough of the wizard, provider choices, local model server Base URLs, and safe re-runs, see docs/onboarding.md.
If an AI assistant is helping with install, reinstall, bootstrap, provider setup, or first-run support, have it read docs/onboarding-agent-checklist.md before running commands or inspecting logs.
~/.hermes/webui/attachments/<session_id>/, or HERMES_WEBUI_ATTACHMENT_DIR/<session_id>/ when configured)file:/// URI in a reply renders through the media route (inline preview for images/audio/video, download otherwise). Windows drive-letter URIs (file:///C:/...) resolve to the drive path on a Windows server; on a POSIX server the leading separator is preserved so a /C:/... request stays absolute and can never alias a workspace-relative file. Only local authorities are served — a file://<host>/... UNC reference is rejected (never silently rewired to a local path), and the file must live under an allowed root (, , the active workspace, or )⋯ dropdown per session — pin, move to project, archive, duplicate, delete/goal.POST /api/projects/bind) but is dormant: the dialog no longer offers the row, and nothing applies a stored value to a new session any more — the only mechanism would be the profile-wide reasoning-effort preference (the same agent.reasoning_effort setting the /reasoning command writes), so a row inside a per-project dialog read as per-project while silently moving the whole profile's effort; it comes back with per-session effort (#7881)workspace://path/to/file open files in the right-side preview paneconfig.yaml at creation time, so Ollama, LMStudio, and other local endpoints can be configured without editing files manuallyHERMES_WEBUI_PASSWORD env var or Settings paneldocs/troubleshooting.md for recovery steps.webui_oidc.issuer, client_id, allow_claim, and allow_values in config.yaml, or set the matching HERMES_WEBUI_OIDC_* environment variables. OIDC stays disabled until all four are present, and startup prints a warning if the config is partial.client_secret_post) by default. When the provider's discovery document only advertises client_secret_basic in token_endpoint_auth_methods_supported (common with strict OIDC stacks such as zitadel/oidc), the secret automatically moves to the HTTP Basic header instead. Set webui_oidc.token_auth_method (or HERMES_WEBUI_OIDC_TOKEN_AUTH_METHOD) to client_secret_basic or client_secret_post to pin a method explicitly./loginsystem, dark, light) and Skin
(default, ares, mono, slate, poseidon, sisyphus, charizard,
sienna, catppuccin, nous, geist-contrast / Geist Contrast)/theme <theme-or-skin>data-skin plus CSS variables; dark mode resolves through the
.dark class, not a data-theme custom-theme axis — see THEMES.md/usage command)/ in the composer for autocomplete dropdown/help, /clear, /compress [focus topic], /compact (alias), /model <name>, /workspace <name>, /new, /usage, /theme/model/model <alias> accepts any alias configured for the profile, in either of Hermes's two formats:
model_aliases: # canonical
sol:
model: gpt-5.6-sol
provider: openai-codex
model:
provider: openrouter
aliases: # legacy
sol: openai-codex/gpt-5.6-sol # provider-qualified
fast: gpt-4 # unqualified
Alias resolution follows the format of the alias:
model_aliases entry and a provider-qualified legacy target name their own
route. The target is authoritative, so /model sol selects that provider even when a
same-named model exists on another provider. A canonical entry also takes precedence over a
legacy entry with the same name./model had before,
and it is unchanged.Aliases that carry their own endpoint or credentials are resolved server-side; the browser only
receives the model, the provider id, and an opaque route id, never a base URL or key.
On the in-process backend, an alias with its own base_url follows Hermes's direct-alias
credential rules: its declared api_key/key_env wins; otherwise only a credential resolved
for that endpoint's own host is sent (for example an OpenRouter key to openrouter.ai), never
the provider label's key to an unrelated host. The alias's provider still selects its wire protocol.
Gateway and runner chat support provider-only aliases by sending the resolved target model
and provider, not the alias name: their runtime does not share WebUI's alias registry. Aliases
that explicitly declare base_url, api_key, or key_env need the in-process backend. External
chat starts, wakeups, Gateway regeneration, and Gateway goal kickoffs reject them with HTTP 400 and
reason: model_alias_requires_in_process_backend before dispatch; a new Gateway goal is not
set. Runner regeneration remains unsupported (HTTP 409), regardless of alias selection.
Ambient credentials resolved for a provider-only alias do not count as alias overrides.
The session retains its target model and profile-bound opaque route id, including Gateway
success/error writeback, so a later backend switch can still resolve the original alias.
A session stores that opaque route id, not the endpoint, so an alias that is later deleted or renamed leaves the session pointing at a route nothing owns. That send fails closed — on every backend, the in-process worker, the gateway and the runner alike — with a controlled "model alias unavailable" error instead of quietly falling back to another provider; pick the model again to store a live route.
With HERMES_WEBUI_RUNTIME_ADAPTER=runner-local, /goal <text> returns HTTP 501
(status: unsupported) without changing an existing goal or starting a run. The
runner contract does not yet provide atomic goal replacement and kickoff; WebUI
never substitutes local goal execution. /goal status, pause, resume, and
clear delegate to the runner when supported. Legacy-direct and legacy-journal
goal kickoff behavior is unchanged for supported routes. Normal runner chat supports provider-only model aliases.
Server-initiated turns retain the pre-session stale-Agent-runtime barrier. It runs before loading the session; named-profile alias and Gateway routing happen only after admission. A stale default local runtime can therefore reject a wakeup before the session's named-profile Gateway ownership is known.
start.sh auto-detects almost everything; the subsections below cover the knobs for when it can't, and how to reach the UI remotely.
| Thing | How it finds it |
|---|---|
| Hermes agent dir | HERMES_WEBUI_AGENT_DIR, then valid authoritative run_agent.py checkouts, the hermes launcher, the selected Python, valid fallback checkouts, and finally marker-only roots |
| Python executable | HERMES_WEBUI_PYTHON, Agent venv, interpreter that proved the Agent root, .venv in this repo, then system Python |
| State directory | HERMES_WEBUI_STATE_DIR env, then $HERMES_HOME/webui (Windows default %LOCALAPPDATA%\hermes\webui, POSIX default ~/.hermes/webui) |
| Default workspace | HERMES_WEBUI_DEFAULT_WORKSPACE env, then ~/workspace, then state dir |
| Port | HERMES_WEBUI_PORT env or first argument, default 8787 |
Before it installs the agent or writes any state, the bootstrap binds the resolved host and port as a preflight. If another service already holds the port, it stops right there, names the address it could not bind, and prints a free alternative to pass to ./start.sh <port> or set as HERMES_WEBUI_PORT in .env. The running service and your existing configuration are left untouched. When the listener on that port is a healthy WebUI -- the instance you already started -- bootstrap reports it ready and leaves it alone, browser included; only a foreign service gets the conflict message.
If discovery finds everything, nothing else is required.
export HERMES_WEBUI_AGENT_DIR=/path/to/hermes-agent
export HERMES_WEBUI_PYTHON=/path/to/python
export HERMES_WEBUI_PORT=9000
export HERMES_WEBUI_AUTO_INSTALL=1 # enable auto-install of agent deps (disabled by default)
./start.sh
Auto-install requires the selected Agent to match HERMES_WEBUI_AGENT_DIR or the Agent under HERMES_HOME, and still checks ownership and permissions.
Or inline:
HERMES_WEBUI_AGENT_DIR=/custom/path ./start.sh 9000
Full list of environment variables:
| Variable | Default | Description |
|---|---|---|
HERMES_WEBUI_AGENT_DIR | auto-discovered | Path to the Hermes Agent source or installed module root |
HERMES_WEBUI_PYTHON | auto-discovered | Python executable |
HERMES_WEBUI_HOST | 127.0.0.1 | Bind address (0.0.0.0 for all IPv4, :: for all IPv6, ::1 for IPv6 loopback) |
HERMES_WEBUI_PORT | 8787 | Port |
HERMES_WEBUI_STATE_DIR | $HERMES_HOME/webui (Windows default %LOCALAPPDATA%\hermes\webui, POSIX default ~/.hermes/webui) | Where sessions and state are stored. Note (upgrade): the default now follows HERMES_HOME — if you previously relocated HERMES_HOME to a non-default base without setting HERMES_WEBUI_STATE_DIR, your WebUI state now resolves to $HERMES_HOME/webui instead of the old platform-default ~/.hermes/webui. To keep using the old location, set HERMES_WEBUI_STATE_DIR to it (or move the directory). Installs with HERMES_HOME unset or at the default base are unaffected. |
HERMES_WEBUI_SETTINGS_FILE | <state dir>/settings.json | Optional path for this instance's WebUI settings file (sessions, workspaces and projects stay in the state directory). Read once at startup, so restart after changing it |
HERMES_WEBUI_DEFAULT_WORKSPACE | ~/workspace | Default workspace |
HERMES_WEBUI_DEFAULT_MODEL | (provider default) | Optional model override; leave unset to use the active Hermes provider default |
HERMES_WEBUI_PASSWORD | (unset) | Set to enable password authentication |
HERMES_WEBUI_CSP_CONNECT_EXTRA | (unset) | Optional space-separated http(s):// or ws(s):// origins to append to the enforced and report-only CSP connect-src directives for trusted reverse-proxy, tunnel, or extension sidecar deployments |
The run journal stores one {run_id}.jsonl per run under sessions/_run_journal/<session_id>/; nothing removed them, so a long-lived session's journal grew without bound. An hourly sweep (piggybacked on the existing maintenance tick, never on a request path) now archives runs past the caps above rather than deleting them:
sessions/_run_journal_archive/<session_id>/<run_id>.jsonl.gz — measured at 5–18% of the original size on real journals;Where dir_fd primitives are unavailable (Windows), the sweep disables itself rather than fall back to path-based moves a directory swap could redirect.
Extension deployments can inspect sanitized, authenticated diagnostics at GET /api/extensions/status; see WebUI Extensions.
Hermes WebUI has a Nix flake package and a NixOS service module so you can run it declaratively.
Install the latest package with:
nix shell github:nesquena/hermes-webui#default
Use this flake input in your system configuration:
inputs.hermes-webui.url = "github:nesquena/hermes-webui";
Then add the module and configure it in nixosModules:
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
hermes-agent.url = "github:NousResearch/hermes-agent";
hermes-webui.url = "github:nesquena/hermes-webui";
};
outputs = { self, nixpkgs, hermes-agent, hermes-webui, ... }: {
nixosConfigurations.<host> = nixpkgs.lib.nixosSystem {
modules = [
hermes-agent.nixosModules.default
hermes-webui.nixosModules.default
({ pkgs, ... }: {
services.hermes-agent.enable = true;
services.hermes-webui = {
enable = true;
host = "127.0.0.1";
port = 8787;
stateDir = "/var/lib/hermes-webui";
user = "hermes";
group = "hermes";
hermesHome = "/var/lib/hermes/.hermes";
agent.package = hermes-agent.packages.${pkgs.stdenv.hostPlatform.system}.default;
environmentFiles = [ "/run/secrets/hermes-webui.env" ];
};
})
];
};
};
}
The module defaults to 127.0.0.1. Set host = "0.0.0.0" and openFirewall = true only when you want direct network access, and pair that with auth, for example HERMES_WEBUI_PASSWORD via environmentFiles.
The published Hermes Agent package exposes passthru.hermesVenv, so the module derives HERMES_WEBUI_PYTHON from its interpreter. Bootstrap then locates the installed run_agent.py through that interpreter without importing Agent code and exports its parent as HERMES_WEBUI_AGENT_DIR. Packages may expose passthru.hermesAgentDir as a direct path instead. Use agent.dir and agent.python as explicit overrides for custom package layouts.
When WebUI reads shared Hermes Agent state, run the service as a user that can already read that state. For a co-located Hermes Agent service, set user and group to the agent service account; the module only creates the default hermes-webui account and never changes ownership of an existing hermesHome.
The module maps directly onto existing WebUI environment variables, including:
HERMES_WEBUI_HOST, HERMES_WEBUI_PORT, HERMES_WEBUI_STATE_DIR, HERMES_HOME, HERMES_WEBUI_AGENT_DIR, and HERMES_WEBUI_PYTHON.
Set environmentFiles for secrets like API keys. Protected WebUI runtime keys from the module are rejected there, so keep host, port, state, and agent wiring in the module options. Keep reverse proxy and TLS configuration in your surrounding deployment module because those details are deployment-specific.
The server binds to 127.0.0.1 by default. To reach it from another machine,
use an SSH tunnel (ssh -N -L 8787:127.0.0.1:8787 user@host, which start.sh
prints for you over SSH) or, on a single-operator or access-restricted tailnet,
use the preferred Tailscale Serve
flow, which keeps WebUI on loopback behind tailnet-only HTTPS. Direct access to
http://<server-tailscale-ip>:8787 with HERMES_WEBUI_HOST=0.0.0.0 and
HERMES_WEBUI_PASSWORD is a fallback when Serve is unavailable. Full setup and
the community ARM64-Android field report: docs/remote-access.md.
If you prefer to launch the server directly (for example from your own systemd unit):
export HERMES_WEBUI_AGENT_DIR=/path/to/hermes-agent # optional, see below
HERMES_WEBUI_PORT=8787 python3 /path/to/hermes-webui/server.py
Before importing anything else, server.py activates the Hermes Agent's dependency environment. It uses HERMES_WEBUI_AGENT_DIR when set, otherwise the same discovery start.sh uses ($HERMES_HOME/hermes-agent, ~/.hermes/hermes-agent, the hermes launcher, …), so the export is only needed for an Agent installed somewhere else. A Hermes-managed Agent (v0.21.6 or newer, installed by the official installer or hermes update) then restarts the server in its own Python with its own dependencies, so the interpreter you launch with does not need the Agent's packages. An older Agent that keeps its dependencies in venv/ or .venv/ is not restarted: run server.py with that venv's Python instead (/path/to/hermes-agent/venv/bin/python). System Python on its own lacks openai, httpx and other required packages.
Health check:
curl http://127.0.0.1:8787/health
Pre-built images (amd64 + arm64) are published to GHCR on every release.
For a comprehensive setup guide covering all 3 compose files, common failure modes, and bind-mount migration, see docs/docker.md. The README covers the 5-minute happy path.
The simplest setup: one WebUI container that runs the agent in-process.
git clone https://github.com/nesquena/hermes-webui
cd hermes-webui
cp .env.docker.example .env
# Edit .env if your host UID isn't 1000 (e.g. macOS where UIDs start at 501)
docker compose up -d
# Open http://localhost:8787
Run Compose as the user who owns your Hermes home. sudo docker compose up -d can make ${HOME} expand to the root user's home, so Docker mounts the wrong .hermes directory instead of your real ~/.hermes and the WebUI starts with config.yaml (not found, using defaults). Prefer adding your user to the Docker group and running docker compose up -d; if you must use sudo, set absolute paths first, for example HERMES_HOME=/home/you/.hermes HERMES_WORKSPACE=/home/you/workspace sudo -E docker compose up -d, then verify with docker compose config.
The container auto-detects your UID/GID from the mounted ~/.hermes volume so files written by the agent stay readable by you on the host.
To enable password protection (required if you expose the port outside 127.0.0.1):
echo "HERMES_WEBUI_PASSWORD=change-me-to-something-strong" >> .env
docker compose up -d --force-recreate
docker run (no compose)docker pull ghcr.io/nesquena/hermes-webui:latest
docker run -d \
-e WANTED_UID=$(id -u) -e WANTED_GID=$(id -g) \
-v ~/.hermes:/home/hermeswebui/.hermes \
-e HERMES_WEBUI_STATE_DIR=/home/hermeswebui/.hermes/webui \
-v ~/workspace:/workspace \
-p 127.0.0.1:8787:8787 \
ghcr.io/nesquena/hermes-webui:latest
docker build -t hermes-webui .
docker run -d \
-e WANTED_UID=$(id -u) -e WANTED_GID=$(id -g) \
-v ~/.hermes:/home/hermeswebui/.hermes \
-e HERMES_WEBUI_STATE_DIR=/home/hermeswebui/.hermes/webui \
-v ~/workspace:/workspace \
-p 127.0.0.1:8787:8787 \
hermes-webui
If you want the agent and WebUI in separate containers (for isolation, or because you're already running an agent gateway elsewhere):
# Agent + WebUI
docker compose -f docker-compose.two-container.yml up -d
# Agent + Dashboard + WebUI
docker compose -f docker-compose.three-container.yml up -d
Both compose files use named Docker volumes by default, which solves the UID/GID problem by construction. If you need bind mounts to share an existing host directory, see docs/docker.md for the full migration recipe.
Known limitation (#681): in the two-container setup, tools triggered from the WebUI run in the WebUI container, not the agent container. If you need git/node/etc. on the WebUI's filesystem, either use the single-container setup, extend the WebUI Dockerfile, or use the community all-in-one image.
Source boundary note (#2453): the multi-container setup mounts
hermes-agent-srcread-only into the WebUI by default. This prevents WebUI-side source rewrites but is still an implementation-coupling bridge, not a stable Agent API boundary. Seedocs/rfcs/agent-source-boundary.mdfor the current source/API decoupling inventory.
| Symptom | Likely cause | Fix |
|---|---|---|
PermissionError at startup | UID mismatch on bind mount | Set UID=$(id -u) in .env |
.env: permission denied (#1389) | fix_credential_permissions() enforced 0600 | Set HERMES_SKIP_CHMOD=1 in .env |
| Workspace appears empty | UID mismatch on /workspace mount | Set UID=$(id -u) in .env |
git: command not found in chat | Two-container architectural limit (#681) | Use single-container or extend Dockerfile |
| WebUI can't find agent source | hermes-agent-src volume misconfigured | Use the named volumes from compose files as-is |
Podman shared .hermes fails | Podman 3.4 keep-id limitation | Use Podman 4+ or single-container |
Host API at localhost fails from WebUI | Container localhost means the container, not your host (#3012) | Use http://host.docker.internal:<port> on Docker Desktop, or http://host.containers.internal:<port> on Podman |
WebUI can't see ~/.hermes after sudo docker compose | ${HOME} expanded to the root user's home (#3006) | Run Compose as your user, or pass absolute HERMES_HOME/HERMES_WORKSPACE with sudo -E |
For the deep dive on each of these, see docs/docker.md.
Note: By default, Docker Compose binds to
127.0.0.1(localhost only). To expose on a network, change the port to"8787:8787"indocker-compose.ymland setHERMES_WEBUI_PASSWORDto enable authentication.
Tests discover the repo and the Hermes agent dynamically -- no hardcoded paths.
Use the repo test runner so local runs do not accidentally use an unsupported
system Python. It creates/uses .venv with Python 3.11, 3.12, or 3.13 and
installs the dev test dependencies from requirements-dev.txt when missing.
cd hermes-webui
./scripts/test.sh
Pass normal pytest arguments after the script for focused runs:
./scripts/test.sh tests/test_regressions.py -v
Or seed the repo .venv from an explicit supported base interpreter:
HERMES_WEBUI_TEST_PYTHON=/path/to/python3.12 ./scripts/test.sh tests/ -v
The override selects the Python used to create or rebuild .venv; dependencies
are still installed into the repo-local virtual environment, not into the
system/Homebrew interpreter.
Tests run against an isolated server with a separate state directory. Production data and real cron jobs are never touched. Current snapshot: ~11,500 tests collected across ~1,150 test files, run in CI on Python 3.11, 3.12, and 3.13 (3 parallel shards each).
No build step, no framework, no bundler — a Python standard-library HTTP server
and vanilla JS. The backend lives in api/, the frontend in static/.
Backend (api/)
server.py HTTP routing shell + auth middleware
api/
auth.py Optional password authentication, signed cookies, passkeys
config.py Discovery, globals, model detection, reloadable config
helpers.py HTTP helpers, security headers
models.py Session model + CRUD + CLI/state.db bridge
onboarding.py First-run onboarding wizard, OAuth provider support
profiles.py Profile state management, hermes_cli wrapper
routes.py All GET + POST route handlers (if/elif dispatch, no decorators)
state_sync.py /insights sync — message_count to state.db
streaming.py SSE engine, run_agent, cancellation, compression
updates.py Self-update check and release notes
upload.py Multipart parser, file upload handler
workspace.py File ops, workspace helpers, git detection
Frontend (static/)
index.html HTML template
style.css All CSS incl. mobile responsive, themes + skins
ui.js DOM helpers, renderMd, tool cards, context indicator
workspace.js File preview, file ops, git badge, central api() fetch wrapper
sessions.js Session CRUD, collapsible groups, search, reload recovery
messages.js send(), SSE handlers, live streaming, session recovery
panels.js Cron, skills, memory, profiles, settings (Control Center)
commands.js Slash command autocomplete
boot.js Mobile nav, voice input, theme/skin boot, bfcache handler
Tests + packaging
tests/ Pytest suite (~11,500 tests; isolated server/state fixtures)
pyproject.toml Standard build metadata plus the Ruff lint gate; checkout launch surface still centers on bootstrap.py / start.sh / ctl.sh
Dockerfile python:3.12-slim container image
docker-compose.yml Compose with named volume and optional auth
.github/workflows/ CI: ruff + sharded pytest, browser smoke, Docker smoke,
multi-arch Docker build + GitHub Release on tag
State lives outside the repo at ~/.hermes/webui/ by default
(sessions, workspaces, settings, projects, last_workspace). Override with HERMES_WEBUI_STATE_DIR.
Full design notes and the endpoint catalog are in ARCHITECTURE.md.
The version shown in the WebUI runtime status is the WebUI version only (build/image/tag currently running). It is not a full compatibility map.
The WebUI is still coupled to Hermes Agent internals for runtime execution, provider/model access, and state/schema usage until the stable agent boundary work in #1925 and #2491 land. In practice, the WebUI imports Agent modules directly (api/config.py, api/providers.py, api/streaming.py) and reads Agent state layout directly, so version skew can cause import or behavior drift.
Compatibility policy
hermes-agent + hermes-webui versions in issue reports when upgrade mismatches are suspected.Docker users: pin both image tags (or corresponding pinned source revisions) rather than using latest on one side and a fixed tag on the other. When upgrading the multi-container setup, follow the agent-image upgrade procedure in docs/docker.md (which requires dropping the hermes-agent-src volume before recreating). The current source-boundary status is tracked in docs/rfcs/agent-source-boundary.md.
Start here
docs/why-hermes.md — why Hermes, the mental model, and a detailed comparison to Claude Code / Codex / OpenCode / Cursordocs/onboarding.md — first-run wizard, provider setup, local model server Base URLs, and safe re-runsdocs/troubleshooting.md — diagnostic flows for common failures (e.g. "AIAgent not available")Using & customizing
THEMES.md — theme + skin system, custom theme guidedocs/workspace-git.md — the workspace Git controlsdocs/kanban.md — the Kanban board's status flow: who may set which column, how tasks enter and leave Scheduled, and the parent re-gating on Scheduled/Blocked → Readydocs/EXTENSIONS.md — administrator-controlled WebUI extension injectionDeploying & operating
docs/remote-access.md — SSH tunnel, Tailscale, and phone access (incl. a community ARM64-Android field report)docs/remote-access-zh.md — 中文远程访问指南:Tailscale、SSH 隧道、Windows 原生部署(自启仅适用 WSL 用户)docs/advanced-chat-setup.md — optional dynamic recall-prefill and Gateway-backed browser chat for self-hosted deploymentsdocs/docker.md — Docker compose setup, common failures, and bind-mount migrationdocs/supervisor.md — launchd, systemd, supervisord, runit, and s6 process-supervisor setupdocs/wsl-autostart.md — WSL2 auto-start at Windows logindocs/onboarding-agent-checklist.md — safety rules and pass/fail checks for assistant-led install/reinstall supportContributing & design
CONTRIBUTING.md — contribution style, PR expectations, and local verificationARCHITECTURE.md — system design, all API endpoints, implementation notesTESTING.md — manual browser test plan and automated coverage referenceDESIGN.md — design tokens and the calm-console directiondocs/UIUX-GUIDE.md — UI/UX principles sourced from the design docs and visual inventoriesdocs/sse-streams.md — cross-client SSE endpoint reference: session streaming, gateway SSE probe scope, heartbeats, and proxy behaviordocs/architecture/transcript-auto-follow-scroll.md — transcript auto-follow contract: pinned/unpinned state model, input-tail re-pinning, reader-resume rules, and the transcript's overscroll suppression rationaledocs/CONTRACTS.md — project contract/RFC/design index for contributors and agentsdocs/rfcs/README.md — RFC index for larger architecture and durability proposalsRelease history & plan
CHANGELOG.md — release notes per versionROADMAP.md — feature roadmap and sprint historySPRINTS.md — forward sprint plan with CLI + Claude parity targetsCONTRIBUTORS.md — the full community credit rollHermes WebUI is built with help from the open-source community. Every PR — whether merged directly, absorbed into a batch release, or salvaged from a larger proposal — shapes the project, and we're grateful to everyone who has taken the time to contribute.
Over 468 contributors have shipped code that landed in a release tag. The full, continuously-updated credit roll — including everyone with one or two PRs and the special-thanks roll for design and architectural work — lives in CONTRIBUTORS.md. A snapshot of the most prolific contributors:
| # | Contributor | PRs | First → latest release |
|---|---|---|---|
| 1 | @rodboev | 399 | v0.51.223 → v0.52.492 |
| 2 | @franksong2702 | 338 | v0.49.3 → v0.52.492 |
| 3 | @Michaelyklam | 157 | v0.50.240 → v0.51.198 |
| 4 | @ai-ag2026 | 155 | v0.50.279 → v0.52.458 |
| 5 | @webtecnica | 91 | v0.51.619 → v0.52.492 |
| 6 | @bergeouss | 80 | v0.48.0 → v0.51.703 |
| 7 | @AJV20 | 57 | v0.51.93 → v0.51.346 |
| 8 | @happy5318 | 56 | v0.50.238 → v0.52.492 |
| 9 | @starship-s | 55 | v0.50.123 → v0.52.492 |
See CONTRIBUTORS.md for the full ranked list of all 468 contributors — the 3+ PR tables, the 1–2 PR roll, and the special-thanks notes for design and architectural contributions.
@franksong2702 — Most prolific external contributor (180 PRs, v0.49.3 → v0.51.384)
Across the longest tenure of any external contributor: the session title guard (#301), breadcrumb workspace navigation (#302), embedded workspace terminal (#1099), worktree-backed session creation (#2053), onboarding documentation (#2052), composer footer container queries, streaming-session sidebar exemption (#1327), session sidecar repair, cron output preservation (#1295), profile default workspace persistence, manual /compress async start/status endpoints (#2128), worktree status surface (#2109) + guarded remove (#2156) for the lifecycle umbrella #2057, session post-render dedup (#2166), native-WebUI fast path (#2170), tail-window response trim (#2171), stale-stream guard extension (#2158), CSP report collector (#2160), and a long tail of polish across mobile/responsive, the session sidebar, and the workspace state machine.
@Michaelyklam — Most prolific contributor of recent releases (118 PRs, v0.50.240 → v0.51.198)
Production Docker hardening (#1921, drops sudo-capable staging user), profile-scoped skills endpoints (#1903), gateway PID resolution under profile-scoped HERMES_HOME (#1901), profile-aware AIAgent cache (#1898/#1904), backslash LaTeX delimiters (#1848), Codex quota error surfacing (#1770), shell-route HTML 503 (#1836), stale Kanban client recovery (#1828), context auto-compression toast lifetime (#1988), /goal command (#1866), Kanban detail-view scrolling (#1916), CLI session tool metadata preservation (#1778), Traditional Chinese kanban locale backfill (#1979), v0.51.51 mobile Insights bucketing/layout (#2120/#2121), Hermes run adapter RFC (#2105 for #1925), fork-from-here absolute index (#2198 for #2184), opencode-go custom-provider overlap routing (#2204 for #1894).
@rodboev — Windows / cross-platform correctness + test reliability (83 PRs, v0.51.223 → v0.51.384)
A broad, sustained sweep with a strong focus on making the project work outside Linux: the ctl.sh Windows process-tree-kill fix (#3670), the local Windows full-suite signal/orphan-process work, slash-command autocomplete polish, and a long tail of frontend and infrastructure fixes shipped across dozens of release batches.
@bergeouss — Provider management UI + Docker hardening (70 PRs, v0.48.0 → v0.51.385)
Provider management UI for adding/editing custom providers from Settings, OAuth provider status detection (#1552), two-container Docker setup, profile isolation hardening (per-profile .env secrets), the bulk of what users see when they touch Settings → Providers, Reveal-in-Finder context menu (#1551), gateway status card (#1552), auto-assign session to active project filter (#1550), "What's new?" link in update banner (#1549), OpenRouter free-tier live fetch (#1548), credential pool 401 self-heal (#1553), inline provider chip + group model count in model picker (#1644).
@ai-ag2026 — Session recovery + audit infrastructure (75 PRs, v0.50.279 → v0.51.367)
Autonomous-AI contributor (Hermes Agent-driven) focused on durability: state.db-backed sidecar reconciliation (#2041), orphan .json.bak recovery on startup (#2035), read-only session recovery audit endpoints (#2036, #2040), active run lifecycle in /health (#2039), crash-safe turn-journal RFC at docs/rfcs/turn-journal.md (#2042), append-only turn-journal helper (#2059), lifecycle events layer (#2062), Content-Security-Policy-Report-Only header (#2084), per-cron toast toggle (#2100), fork-session compression lineage isolation (#2014).
@dso2ng — Session lineage + diagnostics (30 PRs, v0.50.227 → v0.51.327)
/api/session/lineage-report/<sid> endpoint for bounded session graph diagnostics (#2012), stale Mermaid render error cleanup (#1337), session_source="fork" continuation-chain isolation (#2063), lazy lineage-report fetch on sidebar badge expand (#2130), and a long tail of frontend reliability fixes around session loading.
@jasonjcwu — Composer + transcript polish (16 PRs, v0.50.227 → v0.51.132)
Sidebar collapse via active-rail click (#2054, fuses #1884 + #1924), composer chip lightbox (#1758), title fixes for tool-heavy first turns, silent compress-status during session switch (#2185), concurrent-send loss fix (#2186), in-transcript steer message badges (#2187), and a string of frontend polish fixes.
@Jordan-SkyLF — Live streaming + UX polish (12 PRs, v0.50.18 → v0.51.66)
Original sprint of workspace fallback resolution, live reasoning cards (#366, #367, #394–#397), then a recent burst: manual "Refresh usage" button on the Provider quota card (#2150), cancelled-turn status classification (#2151), Firefox sidebar scroll stabilization (#2200), early provisional session titles (#2202), target-aware "What's new?" update-banner links (#2207), and MCP tools overflow fix in Settings (#2210).
@aronprins — v0.50.0 UI overhaul (PR #242, plus 9 follow-ups)
The biggest single contribution to the project: a complete UI redesign that moved model/profile/workspace controls into the composer footer, replaced the gear-icon settings panel with the Hermes Control Center (tabbed modal), removed the activity bar in favor of inline composer status, redesigned the session list with a ⋯ action dropdown, and added the workspace panel state machine. Plus chat transcript redesign (#587), sidebar declutter (#584), three-column layout refactor (#899), light/dark theme + accent skins (#627), and shared confirm()/prompt() dialog replacement (PR #251 extracted from #242).
@iRonin — Security hardening sprint (PRs #196–#204) Six consecutive, focused security PRs: session memory leak fix (expired token pruning), CSP + Permissions-Policy headers, 30-second slow-client connection timeout, optional HTTPS/TLS support via environment variables, upstream branch tracking fix for self-update, and CLI session support in the file-browser API. The kind of focused, high-quality security work that makes a self-hosted tool trustworthy.
@lucasrc — Auth-hardening trilogy (PRs #2191, #2192, #2193) Three coordinated security PRs that all landed in v0.51.57: thread-safe login rate limiter with PBKDF2 key separation, password-hash cache invalidation on Settings save, and the full 64-char HMAC-SHA256 session signature with a backwards-compatible migration bridge. The kind of cleanly-decomposed security work that's reviewable as three independent pieces.
@LumenYoung — Streaming hot-path correctness (8 PRs, v0.51.47 → v0.51.99)
The original stale-stream writeback guard (#2136 — the bug class the next two releases extended), gateway-state alive-null classification (#2075), compression-banner anchor alignment (#2182), and context-progress ring auto-refresh on compression complete (#2188). Each PR opened a small surgical fix in one of the most fragile subsystems in the codebase.
@dobby-d-elf — Frontend reliability + motion polish (15 PRs, v0.51.38 → v0.51.161)
Workspace fallback on deleted directories (#2138), iPhone PWA bottom-scroll fix (#2143), the new "Activity: X tools" composer footer shimmer animation (#2203), and follow-up animation tuning (#2212).
@JKJameson — Composer + session polish (10 PRs) Persistent composer draft per session (#1956), and a long tail of polish across the composer and session sidebar.
@gabogabucho — Spanish locale + onboarding wizard
Full Spanish (es) locale covering all UI strings, plus the one-shot bootstrap onboarding wizard that guides new users through provider setup on first launch.
@deboste — Reverse-proxy auth + mobile responsive layout (PRs #3, #4, #5) Three of the very first community PRs: fixed EventSource/fetch to use URL origin for reverse-proxy setups, corrected model provider routing from config, and added mobile responsive layout with dvh viewport fix. Early foundation work.
@indigokarasu — Visual redesign proposal (PR #213) A CSS-only redesign of the full UI — proper design tokens, an icon rail sidebar replacing the emoji tab strip, consistent form cards, breadcrumb nav, and 7 built-in themes as custom properties. The PR didn't merge as-is but shaped the design language and theme architecture that shipped in v0.50.0.
@zenc-cp — Anti-hallucination guard for the ReAct loop (PR #133) A three-layer approach (ephemeral anti-hallucination prompt, live token filtering, session-history cleanup) that the streaming pipeline still uses.
@Hinotoi-agent — Profile + session security (PRs #351, #2048)
Profile .env secret isolation fix (PR #351) preventing API key leakage between profiles, and session-import workspace validation (PR #2048) blocking a crafted-JSON file-read against /.
@Sanjays2402 — Endless-scroll + Start-jump race fix (PR #1949)
A generation-token + mutex pair fixing the v0.51.30 race between endless-scroll prefetch and Start-jump's _ensureAllMessagesLoaded. The naive same-flag-check approach (proposed in #1942 and #1962) was a no-op for the post-await race — Sanjays2402's fix was the correct shape.
@fxd-jason — Real-time approval + clarify via SSE (PRs #1350, #1355) Replaced 1.5s HTTP polling with SSE long-connections for both approval and clarify, cutting latency from up to 1.5s to near-instant. Got all the correctness details right (atomic subscribe + snapshot, notify-inside-lock, head-of-queue payload, trailing event re-emission).
@happy5318 — Custom provider model dedup (PR #1947) Fixed the same model from different named custom providers being silently deduplicated in the picker, with Opus catching a race in the original tests that needed augmentation.
@NocGeek — Streaming scroll + manual cron output persistence (7 PRs) Streaming scroll viewport stability when tool/queue cards insert (#1360), manual cron-run output and metadata persistence (#1372, split from held #1352).
@DavidSchuchert — German translation (PR #190)
Complete German locale (de) covering all UI strings, settings labels, commands, and system messages — and stress-tested the i18n system, exposing several elements that weren't yet translatable and getting them fixed as part of the same PR.
@Bobby9228 — Mobile Profiles button (PR #265) Added the Profiles entry to the mobile navigation flow, making profile switching reachable on phones.
@kevin-ho — OLED theme (PR #168) The 7th built-in theme: pure black backgrounds with warm accents tuned to reduce burn-in risk.
@andrewy-wizard — Chinese localization (PR #177)
Initial Simplified Chinese (zh) locale. One of the first non-English locales.
@DelightRun — session_search fix for WebUI sessions (PR #356)
Tracked down the missing SessionDB injection in the streaming path that was silently breaking the tool for every WebUI session.
@lawrencel1ng — Bandit security fixes (PR #354)
Systematic bandit-scan fixes: URL scheme validation before urlopen, MD5 usedforsecurity=False, and 40+ bare except: pass blocks replaced with proper logging.
@shaoxianbilly — Unicode filename downloads (PR #378)
Proper Content-Disposition with RFC 5987 filename*=UTF-8''... encoding so non-ASCII filenames download without crashing.
@lx3133584 — CSRF fix for reverse proxy (PR #360) A real-world blocker for anyone hosting behind Nginx Proxy Manager or similar on a port other than 80/443.
@betamod — Security audit (PR #171) A comprehensive CSRF / SSRF / XSS / env-race-condition audit that shipped in v0.39.0.
@TaraTheStar — Bot name + thinking blocks + login refactor (PRs #132, #176, #181) Configurable assistant display name, thinking/reasoning block display, and a login page refactor.
[email protected]:nesquena/hermes-webui.git
HERMES_HOME/tmpMEDIA_ALLOWED_ROOTS/usage command)HERMES_WEBUI_CSP_IMG_EXTRA | (unset) | Optional space-separated http(s):// image origins (wildcard subdomain and port allowed), or the bare https: / http: scheme, added to the CSP img-src. Remote images are blocked by default so an assistant reply cannot make the browser fetch an arbitrary URL; blocked images render as an inert "Open image" link. Use this to show images from a trusted CDN inline, e.g. an image-generation provider |
HERMES_WEBUI_SSE_CHUNKED | (unset) | Set truthy (1/true/yes/on) to send SSE with Transfer-Encoding: chunked. Needed behind buffering reverse proxies (e.g. jupyter-server-proxy) that otherwise buffer the whole stream; harmless but unnecessary for directly-served deployments |
HERMES_WEBUI_EXTENSION_DIR | (unset) | Optional local directory served at /extensions/; must point to an existing directory before extension injection is enabled |
HERMES_WEBUI_EXTENSION_MANIFEST | (unset) | Optional relative JSON manifest inside HERMES_WEBUI_EXTENSION_DIR listing bundled scripts/styles to inject; see WebUI Extensions |
HERMES_WEBUI_EXTENSION_SCRIPT_URLS | (unset) | Optional comma-separated same-origin script URLs to inject; appended after manifest scripts; see WebUI Extensions |
HERMES_WEBUI_EXTENSION_STYLESHEET_URLS | (unset) | Optional comma-separated same-origin stylesheet URLs to inject; appended after manifest stylesheets; see WebUI Extensions |
HERMES_HOME | Windows: %LOCALAPPDATA%\hermes; POSIX: ~/.hermes | Base directory for Hermes state (affects all paths) |
HERMES_CONFIG_PATH | $HERMES_HOME/config.yaml | Path to Hermes config file |
HERMES_WEBUI_SERVER_CWD | (unset) | Working directory for the server process. Defaults to the agent dir; point it at a writable workspace when the agent dir is read-only so fallback relative writes land somewhere writable |
HERMES_WEBUI_VISIBLE_SESSION_LIMIT | 20 | Size of the sidebar's interactive recency window (how many recent non-cron/webhook sessions are listed). Also bounds how many delegated subagent children can nest at once, since a child only renders when its row wins a slot in the window — raise it for wide fan-outs. Non-integer or non-positive values fall back to the default. Values above 200 are clamped. Resolved before profile init, so a profile .env cannot override it |
HERMES_WEBUI_AGENT_CACHE_MAX | 25 | Max live agent instances kept warm in the in-memory LRU. Each pins a full conversation transcript, so this is the dominant lever on resident memory — lower it on installs with many long sessions to cap RAM (at the cost of more cold reloads) |
HERMES_WEBUI_SESSIONS_MAX | 100 | Legacy operator override for the max compact Session objects held in the in-memory LRU. Prefer the webui.sessions_cache_max key in config.yaml (which takes precedence); this env var remains a fallback. Bounds resident memory so long-running installs cannot accumulate every session ever touched and eventually crash (#4765/#2233/#4633). Eviction only ever drops clean, persisted, non-active sessions; an evicted session lazily reloads from its JSON sidecar on next access |
HERMES_WEBUI_RUN_JOURNAL_SWEEP | (unset) | Set to 0/false/off to disable the run-journal retention sweep entirely (#7613) |
HERMES_WEBUI_RUN_JOURNAL_RETENTION_TTL_DAYS | 14 | Runs whose journal file is older than N days are archived (compressed into _run_journal_archive/, not deleted). 0 disables the age cap. Also settable via run_journal_retention_ttl_days in settings.json (the env var wins) |
HERMES_WEBUI_RUN_JOURNAL_RETENTION_MAX_RUNS_PER_SESSION | 40 | Keep at most N newest runs live per session; older runs are archived. 0 disables the count cap (run_journal_retention_max_runs_per_session in settings.json) |
HERMES_WEBUI_RUN_JOURNAL_RETENTION_MAX_BYTES_PER_SESSION | 268435456 (256 MiB) | Per-session budget for LIVE run-journal bytes; sessions over budget archive their oldest runs. 0 disables the size cap (run_journal_retention_max_bytes_per_session in settings.json) |
HERMES_WEBUI_RUN_JOURNAL_ARCHIVE_TTL_DAYS | 0 (keep forever) | The only destructive knob: archives older than N days are deleted, except an archive a session still needs to recover an interrupted answer, which is kept until the session no longer references it or is deleted. 0 (default) never deletes archives — a stock install keeps every archived run forever (run_journal_archive_ttl_days in settings.json) |
| 10 |
| @dso2ng |
| 43 |
v0.50.227 → v0.51.578 |