Svrnty plugin for nesquena/hermes-webui — single repo for every backend + brand mod (per hermes/docs/SVRNTY-PLUGIN-PROTOCOL.md)
|
All checks were successful
plugin-tests / test (push) Successful in 5s
Closes the documentation gap surfaced by the compliance audit. Plugin now
passes the "well organized + well documented" bar in addition to the
"protocol §10 compliant" bar.
Changes:
manifest.yaml bump plugin_version 0.1.0 → 0.2.0 · routes status: live ·
audio_processors section added · public_api adds
register_audio_attachment_processor · tested_versions
appended (v0.51.117, v0.51.118) · current_local synced
README.md Status table flipped from "TBD" to "live" everywhere ·
forced internal deps + test count surfaced
.env.example declares the 4 env vars the plugin reads at runtime
(HERMES_WEBUI_PYTHON_PLUGIN · HERMES_WEBUI_STT_URL/_KEY ·
BTE_BASE_URL · BTE_TENANT_ID)
CHANGELOG.md v0.1.0 (scaffold + vault + brand) · v0.2.0 (STT + mic +
loader API extension)
LICENSE proprietary, contact jp@svrnty.io; clarifies that runtime
integration with hermes-webui (MIT) is permitted
tests/integration/test_loader_contract.py
3 real assertions against the adjacent fork — 7-method
contract, register-our-plugin end-to-end, noop-when-env-unset
29/29 tests PASS (was 26; +3 integration).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
||
|---|---|---|
| .github/workflows | ||
| routes | ||
| scripts | ||
| static | ||
| svrnty_hermes_webui_plugin | ||
| tests | ||
| .env.example | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| CONNECTION-MAP.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| manifest.yaml | ||
| plugin.py | ||
| pyproject.toml | ||
| README.md | ||
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 6 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
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 + reportpython scripts/ast-connection-map.py— regenerate the mappython scripts/boot-smoke.py— start + curl every plugin endpointpytest 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) |