svrnty-hermes-webui-plugin/README.md
Svrnty 33014fbea9
Some checks failed
plugin-tests / test (push) Successful in 6s
upstream-drift / drift (push) Failing after 36s
docs(claude+readme): standardize CLAUDE.md, sync loader API method count 6 → 7
- CLAUDE.md: drop Karpathy block, list all 7 loader methods incl
  register_audio_attachment_processor
- README: extend "Public extension API" to 7 methods

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-23 11:46:44 -04:00

3.1 KiB

svrnty-hermes-webui-plugin

THE single repo holding every Svrnty modification to nesquena/hermes-webui. Loaded at runtime via the plugin loader hook patched into the fork.

Protocol contract: hermes/docs/SVRNTY-PLUGIN-PROTOCOL.md — read this before contributing.

Adding features? Read CONTRIBUTING.md for the 5 recipes + decision flowchart.

Install

# 1. Install the plugin in the same venv as hermes-webui
pip install -e ~/workspaces/hermes/svrnty-hermes-webui-plugin

# 2. Tell hermes-webui to load it
export HERMES_WEBUI_PYTHON_PLUGIN=svrnty_hermes_webui_plugin
# or set in docker-compose.override.yml under environment:

# 3. Restart hermes-webui — endpoints under /api/* + assets under /plugins/svrnty/* land

Without HERMES_WEBUI_PYTHON_PLUGIN, hermes-webui runs vanilla (no Svrnty mods).

What's in here

Dir What
plugin.py Entry point — register(api) wires routes + static
routes/ One file per Svrnty /api/* endpoint (transcribe, vault_status, …)
static/ Brand skin: app.js, app.css, Montserrat fonts
CONNECTION-MAP.md AST-generated map of every upstream symbol this plugin touches
scripts/ Tooling — AST walker, upstream sync, boot smoke
tests/ Unit · integration · evals (each upstream-sync runs evals)
.github/workflows/ Plugin-tests · connection-map-check · upstream-drift CI

Public extension API

The plugin loader (one fork commit in hermes-webui) exposes exactly 7 methods:

api.register_route(path, method, handler)         # add /api/<path>
api.register_static(prefix, directory)            # serve files under /plugins/<prefix>/...
api.inject_script(url)                            # add <script> to index.html
api.inject_stylesheet(url)                        # add <link> to index.html
api.config_get(key, default)                      # safe upstream config read
api.logger(name)                                  # namespaced logger
api.register_audio_attachment_processor(fn)       # hook STT/voice attachment pipeline

Touching anything else in hermes-webui = a Rule 2 violation per the protocol. Document the escape hatch in CONNECTION-MAP.md under "forced internal dependencies".

Hygiene

  • make sync-upstream — one-command rebase against latest upstream + report
  • python scripts/ast-connection-map.py — regenerate the map
  • python scripts/boot-smoke.py — start + curl every plugin endpoint
  • pytest tests/ — full suite (unit + integration + evals)

Status

Component State
Loader hook in hermes-webui ✓ live (lone fork commit, 7-method API)
Plugin scaffold ✓ live (routes/static/tests/scripts/.github)
Migrated features (vault_status, transcribe, brand skin, voice-message mic) ✓ live
Automation (drift CI, AST connection map, sync command, eval suite) ✓ live (Gitea runner registered)
Upstream PR to nesquena/hermes-webui deferred — gated on 2+ release smoke (PRD Phase 4)
Forced internal dependencies 0 (plugin uses only public API)
Test suite 26/26 PASS (unit + evals)