Files
hermes-agent/hermes_cli/plugins_manifest.py
Teknium 9bcbe7b5df feat(i18n): pluggable, layered language packs across core, Desktop and TUI (#126296)
* feat(i18n): layered catalogs — plugin packs and user overlay over bundled locales

* feat(tui): i18n layer — en catalog, nanostore runtime, RPC pack loader, _keys.tui.json emitter

ui-tui/src/i18n/: en.ts (facade over topical siblings under en/), types.ts
(Translations + dotted TranslationKey derived from en), runtime.ts ($locale/
$catalog atoms, translateFrom active→en→key, pack merge with string→fn
wrapping for {0}/{1} placeholders), loader.ts (display.language →
i18n.catalog {lang, surface:'tui'}, English when the method is missing),
useT()/useLocale() hooks, t() for non-React code. useConfigSync feeds the
loader from the existing config.get full hydration. `npm run i18n:keys`
writes locales/_keys.tui.json (sorted flat key list) and runs before build.

* feat(plugins): provides_locales manifest field, ctx.register_locale/register_locale_dir, manifest-only language packs

* chore(tui): split en catalog siblings by lane (slash sibling)

* feat(plugins): validate language packs — parse, text-only, key-subset WARN against en / _keys exports

* feat(tui_gateway): i18n.languages / i18n.catalog RPC + regenerated contracts

* feat(config): display.language accepts any supported_languages() id, refuses unknown ids with the list

* docs(i18n): language packs user guide, pluggable display.language, plugin developer section, AGENTS notes

* feat(plugins): report language-pack layers in the mid-run activation summary

* feat(tui): wire status bar, composer placeholders, hotkey help and approval/clarify/confirm prompts through i18n

StatusRule maps compared state values (ready/running…/summoning) to catalog
text at render via displayStatus(); hotkeys()/placeholder() resolve lazily so
a pack that arrives after boot applies. Catalog grows to 81 keys.

* feat(desktop): pluggable app locales — registry, host.i18n.registerAppLocale, backend packs, keys emitter

- Locale widens to string (BundledLocale keeps the union); TRANSLATIONS stays
  the bundled record and every consumer resolves through the registry.
- src/i18n/registry.ts: registerAppLocale(id, {endonym, rtl, translations})
  layers partial packs (nested or flat dotted) over bundled/en via
  mergeTranslations; a string over a function-valued en entry becomes a
  positional {0}/{1} formatter; $appLocaleVersion bumps so translators
  re-render; per-source disposers + replaceAppLocaleSource for atomic swaps.
- Backend packs: i18n.languages + i18n.catalog {surface:'desktop'} feed the
  registry as source 'backend' (method-not-found is silent); re-synced on
  socket open, display.language change and profile switch. A saved pack-only
  language is promoted once its pack registers.
- SDK: host.i18n.registerAppLocale / languageOptions; ctx.i18n.registerAppLocale
  tracked for unload. Docs in the desktop plugin SDK guide + skill reference.
- Language switcher lists bundled ∪ registered ∪ backend, endonym-only; RTL
  from the registry (applyDocumentLocale takes rtl).
- npm run i18n:keys emits locales/_keys.desktop.json (wired into build).

* i18n(cli): route /topup + /subscription copy through t() (cli.billing.*, cli.subscription.*)

Module-level copy tables and modal choice tuples in cli_billing_mixin.py froze
English at import, before display.language was known. They are now key tables /
builder functions evaluated at call time; every user-facing line in the /usage
balance block, /subscription and the five /topup screens reads the catalog.
Choice VALUES stay English identifiers. Fragment-assembled status lines
(Plan: … → cancels · $x left · renews …) become full templates.

* i18n(gateway): exec-approval card contract + base/run/run_busy/run_inbound replies through t()

- base_exec_approval: EA_* English constants stay; add ea_header_text()/ea_reason_label_text()/
  ea_smart_deny_line_text()/ea_default_reason_text()/ea_action_labels()/approval_timed_out_notice()
  accessors; deadline + timed-out notice resolve via gateway.exec_approval.*
- BasePlatformAdapter._EA_HEADER/_EA_REASON_LABEL/_EA_SMART_DENY_LINE/_EA_ACTION_LABELS become
  properties (adapters still shadow them with markup class attrs)
- run.py: provider error replies table holds catalog keys; _CONTEXT_OVERFLOW_REPLY -> _context_overflow_reply()
- run_busy/run_inbound: typed approval + slash-confirm matchers accept English ∪ approval.inputs.* (t())
- locales/en.yaml: gateway.exec_approval/busy/errors/... namespaces

* i18n(cli): wire modal, loops, agent-setup mixins through t() (cli.* keys)

* i18n(platforms): route Slack, Matrix and Feishu user-facing text through t()

Exec-approval markup overrides (_EA_HEADER/_EA_REASON_LABEL/_EA_SMART_DENY_LINE/
_EA_ACTION_LABELS) become per-call properties over the shared
gateway.exec_approval.* contract keys, so Slack's 3000-char section budget
measures the resolved template. Slack _APPROVAL_DECISIONS/_CONFIRM_DECISIONS,
Feishu _APPROVAL_LABEL_MAP and Matrix _EA_LEGEND/_EA_TYPED_HINT turn into
key tables resolved at click time; the Matrix typed hints become whole
sentences per offered tier instead of spliced fragments. Slack button labels
are cut to 75 chars and select placeholders to 150 after translation; the
model-facing clarify fallback answer ('choice N') stays English while the
card copy localizes.

locales/en.yaml gains the gateway.exec_approval.* contract keys plus the
platform.shared.* / platform.slack.* / platform.matrix.* / platform.feishu.*
namespaces (and the keys for the other adapters wired in follow-up commits).

* i18n(gateway): run_turn / run_turn_runner / approval-settle copy through t()

- status hints, proxy errors, background task notices, progress heartbeats, session info lines
- tool progress chrome (tool_head/tool_pending/tool_preview/tool_verbose) shared by base.format_tool_event
- run_turn_runner:1406 Chinese clarify placeholder -> gateway.clarify.native_stream_placeholder (zh text kept in zh.yaml)
- _UNEXPECTED_SILENCE_REPLY/_CLARIFY_EXPIRED_NOTICE -> accessor functions

* i18n(platforms): route Google Chat and Teams user-facing text through t()

Google Chat clarify card, typing placeholder, orphan-card labels and the whole
/setup-files reply set (module constants become platform.google_chat.setup_files.*
keys resolved at reply time). The attachment-fallback notice that shipped
hardcoded in Spanish is keyed with an English en value; es.yaml carries the
original Spanish text for those four keys.

Teams approval card header/reason use the gateway.exec_approval.* contract,
_APPROVAL_LABELS becomes a key table resolved at click time, and the meeting
summary writer resolves its section headings/fallbacks per render.

* i18n(platforms): route LINE, WeCom, email, DingTalk, IRC and Home Assistant text through t()

LINE default copy constants become catalog keys resolved in __init__ (the
LINE_*_TEXT / extra.* operator overrides still win); the busy-ack bypass
matcher keys on the leading emoji marker only, so it keeps firing once the
gateway busy heads are localized. WeCom media size/format notices that shipped
hardcoded in Chinese are keyed with English en values and zh.yaml carries the
original Chinese text. DingTalk emotion bubbles resolve per send.

* i18n(cli): route /model switch output and -q status lines through t() (cli.model.*, cli.single_query.*)

Switch-summary labels shared with the gateway reuse gateway.model.* keys
(provider/context/max-output/capabilities/prompt-caching); CLI-only variants
(glyph or no-backtick forms) live under cli.model.*. The hand-padded /model usage
block becomes a (form, description-key) table padded at render time so the
command syntax stays fixed while descriptions translate. -q 'Error:' reuses
gateway.model.error_prefix.

* i18n(cli): route TUI panel/hint/placeholder copy through t() (cli.tui.*)

_APPROVAL_CHOICE_LABELS and _TUI_MODAL_HINTS become key tables resolved at
render time; vault/sudo panel bodies are one catalog value per panel split on
newline; inline plurals use <key>_one/<key>_other. Adds the cli.* namespace
(shared/tui/voice/render/subagents/dock) to locales/en.yaml.

* i18n(cli): voice/wake-word CLI copy through t() (cli.voice.*)

RuntimeError texts raised in _voice_start_recording are human copy (callers
print {e}) and are keyed; the Termux requirement-check match stays English.
Wake state ids stay internal, only their labels localize.

* i18n(cli): live-work dock, subagent monitor and render copy through t()

cli.subagents.* / cli.dock.* / cli.render.*; count fragments pluralize via
_one/_other keys, verdict table holds keys resolved at paint time so width
clipping measures the translated text.

* i18n(gateway): unauthorized/pairing, voice, topics, shutdown, startup, notifications, kanban pings through t()

* i18n(cli): move tips + composer placeholders into the catalog (tips.tNNN / tips.placeholder.pNN)

get_random_tip()/get_random_composer_placeholder() pick a key from the English catalog
(the parity baseline, probed once per process) and resolve it through t() for the active
language, so language packs translate tips like any other string. Also lands the cli.*
en.yaml namespace consumed by the CLI info/help/error-copy wiring in the next commit.

* i18n(cli): wire chat-turn + session mixins through t(); kanban log trimmer matches t() output

* test(cli): assert TUI/dock/voice copy via t(key); prove labels resolve at render time

Pinned-English assertions in the approval-UI, live-work dock and voice tests now
go through the catalog. New test swaps the catalog after import and checks the
approval panel + hint row follow it (the reason _APPROVAL_CHOICE_LABELS and
_TUI_MODAL_HINTS became key tables).

* i18n(cli): route CLI info/help/error copy through t() (cli.* namespace)

cli_info_mixin: /help consumes CommandDef.describe() (added to commands.py: slash.<name>.description
with fallback to .description), section titles/skill/quick-command headers, /tools, /toolsets,
/usage labels, /context, /whoami, /insights, /gateway status, tool-progress labels, bang-shell
denials, MCP config-watch + /reload-mcp confirm/reload lines, /reload-skills, and the session-store
warning all read the catalog at call time (module-level label tables became functions so the
active language is honoured after startup). cli.py: worktree cleanup, tirith warning, show_config
(labels re-padded at print time), quick/plugin/skill slash-command errors, ambiguous-command hint,
stdin error, gateway start, profile warning. cli_chat_error_copy / cli_unknown_command /
cli_output / cli_init_mixin: chat error panel copy, did-you-mean lines, n-more / yes-no prompt
(localized affirmative initial alongside 'y'), unknown-toolsets warning.

* i18n(w1a): wire agent display/explainers/approval + slash registry/help through t()

- hermes_cli/commands.py: CommandDef.describe() resolves slash.<name>.description
  at call time; category labels via slash.category.*; help/alias/usage suffixes
  via slash.shared.*; gateway_help_lines and commands_platforms/slash_exec use them.
- agent/display.py: display.verb.* resolved at call time via get_tool_verb();
  bridge/spinner/thinking-verb/cute-row/failure/preview/diff text via display.*.
- agent/turn_explainers.py: exit-reason / persistence-cause tables become call-time
  lookups (explainer.exit.*, explainer.persistence.*, explainer.file_mutation.*).
- agent/background_review.py, session_activity.py, context_breakdown.py,
  status_output.py: review summaries, iteration progress, context notices.
- tools/approval.py, approval_context.py: approval.summary.*, approval.noun.*,
  approval.window.* pluralized keys.
- gateway/slash_commands*.py: remaining raw strings (busy, whoami, platform,
  bundles, memory, skills, approvals, set_home, diff, update, debug, profile,
  heartbeat, refine, review, subgoal, loop, retry, compress codex path, save,
  sessions, model guard/errors, agents rows, topup, login). HISTORY_UNREADABLE
  keeps its English constant; callers use history_unreadable() ->
  gateway.shared.history_unreadable.
- locales/en.yaml: new approval/display/explainer/slash blocks + gateway leftovers.

* i18n(telegram): route adapter chat copy through t()

Approval card (header/reason/smart-deny as HTML-escaped properties), inline
button labels, callback toasts (cut at Telegram's 200-char cap), model/choice
pickers, clarify/update/slash-confirm prompts, gmail-triage labels and the
inbound-media failure notice now come from the catalog. _UNAUTHORIZED is a
lazy _unauthorized() so the import no longer binds a language. The command
menu carries a language+payload fingerprint (forum scopes re-register on
change) and BotCommand descriptions are cut at 256.

Adds gateway.exec_approval.* (WAVE2 contract), platform.telegram.*,
platform.discord.* and the slash.*.description keys the Discord table shares
with the CLI registry to locales/en.yaml.

* i18n(gateway/platforms): whatsapp_cloud, yuanbao, weixin, signal, api_server copy through t()

- whatsapp_cloud: clarify list/buttons, approve/deny + slash-confirm labels via platform.whatsapp.* (t()-then-truncate at 20/24/72 caps); _EA_HEADER becomes a property wrapping ea_header_text()
- yuanbao: SLOW_RESPONSE_MESSAGE -> slow_response_message() (platform.yuanbao.slow_response_notice; zh keeps the original text); cron-wrapper markers centralized as module constants for strip_cron_wrapper
- api_server: PROVIDER_AUTH_FAILED_LABEL/PROVIDER_RATE_LIMITED_LABEL stay English for run.py matchers; user_text() renders via t()
- signal/_format_wait, weixin voice caption, openai_routes transformed notice
- run_turn: second _UNEXPECTED_SILENCE_REPLY consumer -> accessor

* i18n(discord): route adapter chat copy through t()

Native slash-command table becomes _NATIVE_SLASH_COMMAND_SPECS holding catalog
keys; _native_slash_commands() resolves descriptions, parameter descriptions
and Choice names for the active language, each cut at Discord's 100-char cap,
and the app-command sync fingerprint now includes get_language() so a
display.language change re-syncs. Exec-approval card (gateway.exec_approval.*
contract), slash-confirm / clarify / update views, model+choice pickers,
thread creation, forum titles, voice acks, the response-truncation notice,
the unauthorized-slash security alert and the media upload-size notices all
read from platform.discord.*. Decorator-declared button labels are relabelled
in __init__ (80-char cap); embed titles cut at 256, select placeholders at
150, option label/description at 100. _UNAUTHORIZED is a lazy _unauthorized().

* i18n(cli): wire status-bar, stream, terminal mixins + terminal_input through t(); rename kwargs that shadow t(key)

* i18n: wire hermes_cli/cli_commands_mixin.py slash-command copy through t()

- 431 new leaves under cli.commands.<cmd>.* in locales/en.yaml; 12 rows reuse
  existing gateway.* keys (rollback, diff, resume, branch, btw, model, reasoning)
  via a _gt() helper so CLI and gateway replies stay identical.
- Module-level English tables (_BUSY_MODE_*, _REASONING_TOGGLES, _HATCH_PROGRESS,
  _DIFF_LABELS, _LOCAL_ENGINE_LINES) become call-time catalog lookups keyed by id.
- Verb tables (Enabling/Disabling, Paused/Resumed/Triggered, planned/done,
  Updating/Generating) are one full template per variant; plurals use
  <key>_one/<key>_other via _tn(); hand-padded column labels (/snapshot list)
  translate the value and re-pad at the call site.
- Multi-line usage blocks are single catalog values split with _lines().
- Model-facing system notes and DB-stored reasons stay English (EXCLUDED).

* tests: assert /handoff, /worktree, /login CLI copy via t(key) instead of pinned English

* test(i18n): pin Telegram/Discord adapter catalog wiring

Lazy unauthorized notice, exec-approval contract keys, HTML escaping before
Telegram <b> wrapping, 200-char toast / 256-char BotCommand caps, Discord
100-char app-command text and 80-char button caps, and language-bearing
command-menu fingerprints on both platforms.

* i18n: reconcile cli.shared on/off vs enabled/disabled after lane merge

* i18n: describe() in TUI-gateway slash listings; localize TUI exit resume hint

* i18n(tr): translate bundled catalog + tui pack

* i18n(ja): translate bundled catalog + tui pack

* i18n(ko): translate bundled catalog + tui pack

* i18n(zh): translate bundled catalog + tui pack

* i18n(fr): translate bundled catalog + tui pack

* i18n(af): translate bundled catalog + tui pack

* i18n(uk): translate bundled catalog + tui pack

* i18n(ar): translate bundled catalog + tui pack

* i18n(pt): translate bundled catalog + tui pack

* i18n(it): translate bundled catalog + tui pack

* i18n(es): translate bundled catalog + tui pack

* i18n(zh-hant): translate bundled catalog + tui pack

* i18n(ru): translate bundled catalog + tui pack

* i18n(hu): translate bundled catalog + tui pack

* i18n(hu): translate pre-existing English-valued leftovers (kanban wake, /context, /status, fast labels)

* i18n(de): translate bundled catalog + tui pack

* i18n(ga): translate bundled catalog + tui pack

* test(i18n): fixture matches _normalize_lang(lang, home) signature

* i18n(tui): scaffold userMessages/slashCmd en siblings

* i18n(tui): wire secure prompts + content tables

* feat(tui): i18n — wire billing, subscription, connection-setup and journey overlays

Adds en siblings billing.ts / subscription.ts / connection.ts (namespaces
billing, subscription, connection, journey) and routes every user-facing
literal in billingOverlay, subscriptionOverlay, connectionSetupOverlay and
journey through useT()/messages(). Module-level label tables became lazy
(scopeStillDeniedResult(), verbOf(T, action)); auto-reload rows dispatch on
stable ids instead of label text. Regenerates locales/_keys.tui.json.

* i18n(tui): wire slash ops/wake replies

* i18n(tui): wire pickers (modelPicker, activeSessionSwitcher, petPicker)

* i18n(tui): wire slash core/debug/setup replies

* i18n(tui): wire hubs (agents overlay/panel/controls, skills, plugins)

* i18n(tui): wire slash session/topup/subscription replies

* i18n(tui): wire chat bits (branding, thinking, messageLine, loaders, todo, queued, banner, entry)

* i18n(tui): register t3 siblings (pickers, hubs, secure, content, chatBits) and regenerate keys

* i18n(tui): wire userMessages copy through the userMessages namespace

* i18n(tui): lazy-copy test for userMessages, regenerate _keys.tui.json

* i18n(tui): wire session/gateway/lib text through the TUI catalog (lane t2)

Adds en siblings session.ts, gatewayMsg.ts, libText.ts (namespaces session,
gatewayMsg, libText) and routes user-facing literals in app/{useMainApp,
useSessionLifecycle,useInputHandlers,turnController,createServerRequestHandler,
setupHandoff,createGatewayEventHandler}.ts, gatewayClient displayed reasons,
lib/*, domain/*, hooks/* through t()/messages(). Status-bar state values that
code compares against, backend-matched strings, log lines, model-bound text,
and machine 'error:' prefixes stay literal. Regenerates locales/_keys.tui.json
(232 keys).

* i18n: serve bundled locales/<lang>.tui.yaml under overlay/packs; TUI pack parity test; regen _keys.tui.json (1250)

* i18n: translate pre-existing English stubs in bundled locales (424 leaves, 14 locales)

* tui: i18n-export-en script (English templates for pack translators)

* docs(i18n): bundled TUI packs are the bottom layer of the tui surface

* i18n(ru): translate TUI pack

* i18n(ar): translate TUI pack

* i18n(es): translate TUI pack

* i18n(pt): translate TUI pack

* i18n(ko): translate TUI pack

* i18n(de): translate TUI pack

* i18n(ja): translate TUI pack

* i18n(fr): translate TUI pack

* i18n(tr): translate TUI pack

* i18n(it): translate TUI pack

* i18n(zh): translate TUI pack

* i18n(zh-hant): translate TUI pack

* i18n(hu): translate TUI pack

* i18n(uk): translate TUI pack

1,169 missing keys translated; 81 pre-existing kept byte-identical. Parity OK missing=0 extra=0 placeholder_mismatch=0 empty=0.

Deliberately identical to en: chatBits.branding.mcpSummary ({0} MCP), chatBits.thinking.agentsHint ((/agents)), session.main.voiceStt (◉ STT), session.main.voiceTtsSuffix ( [tts]), slashCmd.core.help.tuiSection (TUI), slashCmd.core.history.hermesTag (Hermes #{0}), slashCmd.debug.heapdump.heapPath (heapdump: {0}), slashCmd.debug.mem.rss (rss), subscription.stepUp.title (Remote Spending — product feature name, as in core catalog), content.faces.* (glyph-only kaomoji).

* i18n(ga): translate TUI pack

* i18n(af): translate TUI pack

* plugin_guard: locale catalogs in language packs step down the agent-config family

A translated status line such as "Updating AGENTS.md" in locales/<lang>.yaml is UI text the loader
reads as a string leaf; it cannot edit a file. The bundled en.yaml itself tripped agent_config_mod
at critical, making any faithful language pack uninstallable. Injection shapes keep full severity.

* plugin_validate_locales: read key exports with utf-8-sig (Windows footgun lint)

* i18n(relay): route relay adapter prompt copy through t(); drop dead import-bound approval header

Adds platform.relay.* (5 keys) to en and all 16 bundled locales, reusing the sibling platform
translations for the confirm buttons and the Other option.

* ci: fix TUI import order, MDX table pipe, main's overflow-warning wording in all locales; fresh-install fixture carries the i18n kernel

- ui-tui/src/i18n/en.ts: perfectionist/sort-imports (slash before slashCmd)
- docs plugins/index.md: escape the | inside the provides_locales table cell (MDX parsed <id> as JSX)
- display.notice.uncompressed_context_overflow: adopt main's wording (names compression.enabled: false
  and /compact) in en + 16 locales; the guardrail test pins that phrase
- tests/scripts/test_fresh_source_install.py: the installer tail now resolves CLI text through
  agent.i18n, so the fixture tree carries the i18n kernel + en.yaml (not the agent runtime)

* docs(desktop-plugin-sdk): double-backtick the template-literal example (MDX evaluated ${n})

* test(e2e): display.language is validated against the live language set; exclude it from the arbitrary-string set property

* commands: keep the localized COMMANDS/COMMANDS_BY_CATEGORY module __getattr__ after the compat block removal

* build: never write locales/_keys.*.json from the desktop/TUI builds; regenerate the committed desktop key export

The desktop build regenerated locales/_keys.desktop.json in the checkout, so a
hermes update that rebuilt the app left the tree dirty (Desktop update E2E:
'M locales/_keys.desktop.json'). The key exports are committed artifacts pinned
to en.ts by apps/desktop/scripts/i18n-keys.test.mjs and ui-tui i18n:keys:check;
builds read them, never write them. Regenerated after main's new desktop strings.

* test: unbreak two main-red timing tests the PR merge-ref inherits

- test_local_runtime racing fake publishes the modern state record (legacy pid-only
  records are rejected since 65ff3ad353; main has been red on this test since)
- test_run_progress_topics ManyProgressLinesAgent waits for the first bubble instead of
  a fixed 0.35s, which a loaded CI runner does not always meet

* chore(i18n): regenerate desktop key catalog for main's new strings (model pricing, copy changelog)

* test(e2e): torture-chamber fd monitor confirms a deleted sidecar is still held before calling it a leak

SQLite's WAL last-close unlinks -shm before closing its descriptor (unixShmUnmap, then
unixShmPurge), so a healthy close shows a (deleted) -shm for microseconds; the 20ms poll
occasionally caught that window on the short-lived opener and failed the episode.

* chore(i18n): regenerate desktop key catalog for main's telemetry/consent strings

* chore(i18n): regenerate desktop key catalog after main sync

---------

Co-authored-by: Teknium <teknium@nousresearch.com>
2026-09-28 14:16:18 -07:00

560 lines
26 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

"""Plugin manifest model and parsing (``plugin.yaml`` v1/v2, portable ``plugin.json``).
Split out of :mod:`hermes_cli.plugins`; validation warns and never fails a load.
"""
from __future__ import annotations
import hashlib
import importlib.util
import logging
import re
from contextlib import suppress
from dataclasses import dataclass, field
from pathlib import Path
from typing import Any, Callable, Dict, List, Mapping, Optional, Set, Tuple, Union
from utils import fast_safe_load
from hermes_cli.plugin_capabilities import parse_declared_capabilities as _parse_declared_capabilities
try:
import hermes_yaml as yaml
except ImportError: # pragma: no cover – yaml is optional at import time
yaml = None # type: ignore[assignment]
logger = logging.getLogger("hermes_cli.plugins")
_VALID_PLUGIN_KINDS: Set[str] = {"standalone", "backend", "exclusive", "platform", "model-provider"}
# Unknown plugin.yaml fields are forward-compat surface: warn (debug for v1 files, warning for v2+)
# and continue loading. ``capabilities``/``emits``/``listens``/``hermes``/``depends`` are reserved.
# ── Manifest v2 (#64165) parsing helpers ──────────────────────────────────
_KNOWN_MANIFEST_FIELDS: Set[str] = {
"name", "version", "description", "author", "requires_env", "provides_tools", "provides_hooks",
"kind", "hooks", "label", "optional_env", "platforms", "external_dependencies",
"pip_dependencies", "provides_browser_providers", "provides_web_providers",
"manifest_version", "api_version", "requires_plugins", "python_dependencies", "config_schema",
"license", "homepage", "tags", "capabilities", "emits", "listens", "hermes", "depends",
"requires_hermes", "python_runtime", "provides_locales",
}
# Highest manifest schema version this Hermes understands.
SUPPORTED_MANIFEST_VERSION = 2
_CONFIG_SCHEMA_TYPES: Dict[str, tuple] = {
"str": (str,), "string": (str,), "int": (int,), "integer": (int,), "float": (int, float),
"number": (int, float), "bool": (bool,), "boolean": (bool,), "list": (list,), "array": (list,),
"dict": (dict,), "object": (dict,),
# ``secret`` values live in ``.env`` (see hermes_cli.plugins_settings), so a config.yaml copy is
# only ever a stray string.
"secret": (str,),
}
def _plugins_debug() -> bool:
from hermes_cli import plugins as _origin
return _origin._PLUGINS_DEBUG
def _portable_skill_namespace(key: str) -> str:
"""Return a readable, collision-resistant namespace for a portable plugin."""
slug = _portable_slug(key)
digest = hashlib.sha256(key.encode("utf-8")).hexdigest()[:8]
return f"agent-plugin-{slug}-{digest}"
def _portable_slug(key: str) -> str:
slug = "".join(ch if ch.isascii() and (ch.isalnum() or ch in "_-") else "-" for ch in key.lower())
return slug.strip("-_") or "plugin"
def portable_mcp_server_name(key: str, server: str) -> str:
"""Internal name of a portable plugin's MCP server: exactly the name its ``mcp.json`` gives it, the same
rule a user's own ``mcp_servers`` block in config.yaml follows. The plugin's skill namespace
(``agent-plugin-<slug>-<digest>``) is NOT prepended: it keeps plugin-data and skill names collision-free
without coordination, but here it cost ~40 chars of every ``mcp__<server>__<tool>`` name, which providers
cap at 64, so the tool verb was hash-clamped away. A duplicate is refused at load (native config first,
then first-loaded plugin) with a warning naming both owners; that beats hiding it behind a digest."""
del key # one signature for loader and card; the plugin identity is deliberately not part of the name
return _portable_slug(server)
def _display_author(value: object) -> str:
"""Normalize a manifest author value for the string PluginManifest field."""
if isinstance(value, Mapping):
return ", ".join(str(value[f]) for f in ("name", "email", "url") if value.get(f))
return "" if value is None else str(value)
def _manifest_field_of_type(data: Mapping, key: str, field_name: str, typ, what: str):
"""Return ``data[field_name]`` when absent or of ``typ``; warn and return None otherwise."""
raw = data.get(field_name)
if raw is not None and not isinstance(raw, typ):
logger.warning("Plugin %s: %s must be %s; ignoring", key, field_name, what)
return None
return raw
def _manifest_list(data: Mapping, key: str, field_name: str, what: str, coerce: Callable, warn: str) -> list:
"""Coerce each item of list field ``field_name``; ``coerce`` returning None warns ``warn`` and skips."""
out = []
for item in _manifest_field_of_type(data, key, field_name, list, what) or []:
coerced = coerce(item)
if coerced is None:
logger.warning(warn, key, item)
else:
out.append(coerced)
return out
def _dependency_entry(item: object) -> Optional[Dict[str, Any]]:
"""``{id, version_range}`` from a requires_plugins item (str shorthand ok); None when malformed."""
if isinstance(item, str):
return {"id": item, "version_range": None}
if isinstance(item, Mapping) and isinstance(item.get("id"), str) and item["id"]:
vr = item.get("version_range")
return {"id": item["id"], "version_range": str(vr) if vr is not None else None}
return None
def _manifest_int(raw: object, key: str, warn: str, fallback: Optional[int]) -> Optional[int]:
"""``int(raw)``; a non-integer warns ``warn`` (formatted with key, raw) and yields ``fallback``."""
try:
return int(raw) # type: ignore[call-overload]
except (TypeError, ValueError):
logger.warning(warn, key, raw)
return fallback
def _parse_manifest_v2_fields(data: Mapping, key: str) -> Dict[str, Any]:
"""Validate/normalize manifest v2 fields into PluginManifest kwargs (warnings, never failures).
See #64165.
"""
# manifest_version — absent means v1 (supported forever); api_version is the independent API generation.
mv = _manifest_int(data.get("manifest_version", 1), key,
"Plugin %s: manifest_version %r is not an integer; treating as 1", 1)
if mv > SUPPORTED_MANIFEST_VERSION:
logger.warning(
"Plugin %s: manifest_version %d is newer than this Hermes "
"supports (%d); loading anyway and ignoring unknown fields", key, mv, SUPPORTED_MANIFEST_VERSION,
)
raw_api = data.get("api_version")
api = None if raw_api is None else _manifest_int(
raw_api, key, "Plugin %s: api_version %r is not an integer; ignoring", None)
deps = _manifest_list(
data, key, "requires_plugins", "a list", _dependency_entry,
"Plugin %s: requires_plugins entry %r must be a plugin id "
"string or a {id, version_range} mapping; skipping",
)
# python_dependencies — validated and surfaced ONLY; never auto-installed.
pydeps = _manifest_list(
data, key, "python_dependencies", "a list of requirement strings",
lambda item: item.strip() if isinstance(item, str) and item.strip() else None,
"Plugin %s: python_dependencies entry %r must be a non-empty requirement string; skipping",
)
# config_schema — mapping of key -> {type?, default?, description?, required?}.
schema: Dict[str, Any] = {}
raw_schema = _manifest_field_of_type(data, key, "config_schema", Mapping, "a mapping")
for skey, spec in (raw_schema or {}).items():
if not isinstance(spec, Mapping):
logger.warning(
"Plugin %s: config_schema entry %r must be a mapping (e.g. {type: str}); skipping", key, skey)
continue
stype = spec.get("type")
if stype is not None and str(stype).lower() not in _CONFIG_SCHEMA_TYPES:
logger.warning(
"Plugin %s: config_schema key %r declares unknown type %r "
"(known: %s); type check will be skipped for it",
key, skey, stype, ", ".join(sorted(_CONFIG_SCHEMA_TYPES)),
)
schema[str(skey)] = dict(spec)
tags = [str(t) for t in (_manifest_field_of_type(data, key, "tags", list, "a list") or [])]
# Forward compat: unknown fields warn (never fail); v1 manifests only at debug.
unknown = sorted(set(data.keys()) - _KNOWN_MANIFEST_FIELDS)
if unknown:
(logger.warning if mv >= 2 else logger.debug)(
"Plugin %s: unknown manifest field(s) ignored: %s "
"(newer manifest schema or typo; plugin still loads)", key, ", ".join(unknown),
)
return {
"manifest_version": mv, "api_version": api, "requires_plugins": deps, "python_dependencies": pydeps,
"config_schema": schema, "license": str(data.get("license") or ""),
"homepage": str(data.get("homepage") or ""), "tags": tags,
}
def validate_config_schema(plugin_id: str, schema: Mapping, settings: Mapping) -> List[str]:
"""Return actionable warning strings for settings vs config_schema mismatches (never raises).
Never raises; schema mismatches must not block plugin load (#64165).
"""
warnings: List[str] = []
if not isinstance(schema, Mapping) or not isinstance(settings, Mapping):
return warnings
for skey, spec in schema.items():
if not isinstance(spec, Mapping):
continue
if skey not in settings:
if spec.get("required") and "default" not in spec:
warnings.append(
f"plugins.entries.{plugin_id}.settings.{skey} is required "
"by the plugin's config_schema but is not set"
)
continue
stype = spec.get("type")
expected = _CONFIG_SCHEMA_TYPES.get(str(stype).lower()) if stype else None
if expected is None:
continue
value = settings[skey]
# bool is an int subclass — don't let True satisfy int/float.
if not isinstance(value, expected) or (isinstance(value, bool) and bool not in expected):
warnings.append(
f"plugins.entries.{plugin_id}.settings.{skey} should be "
f"{stype} (got {type(value).__name__})"
)
return warnings
def resolve_plugin_load_order(manifests: Mapping[str, "PluginManifest"]) -> List[str]:
"""Return plugin keys in dependency order: B before A when A requires B; alphabetical ties. A cycle warns
and falls back to alphabetical order for all; a missing dependency warns once but never removes the
dependent plugin (loads never hard-fail on advisory deps).
See #64165.
"""
import graphlib
keys = sorted(manifests.keys())
by_name: Dict[str, str] = {}
for k in keys:
if manifests[k].name:
by_name.setdefault(manifests[k].name, k)
edges: Dict[str, Set[str]] = {k: set() for k in keys}
for k in keys:
for dep in manifests[k].requires_plugins:
dep_id = dep.get("id") if isinstance(dep, Mapping) else None
if not dep_id:
continue
resolved = dep_id if dep_id in manifests else by_name.get(dep_id)
if resolved is None:
logger.warning(
"Plugin %s requires plugin '%s' which is not enabled/"
"installed; loading anyway (probe availability at runtime "
"via ctx.has_plugin). Run `hermes plugins enable %s` if it is installed.",
k, dep_id, dep_id,
)
elif resolved == k:
logger.warning("Plugin %s declares a dependency on itself; ignoring", k)
else:
edges[k].add(resolved)
sorter = graphlib.TopologicalSorter(edges)
try:
sorter.prepare()
except graphlib.CycleError as exc:
cycle = exc.args[1] if len(exc.args) > 1 else []
logger.warning(
"Plugin dependency cycle detected (%s); falling back to "
"alphabetical load order for all plugins", " -> ".join(str(c) for c in cycle),
)
return keys
ordered: List[str] = []
while sorter.is_active():
ready = sorted(sorter.get_ready())
ordered.extend(ready)
sorter.done(*ready)
return ordered
def _detect_kind_from_source(source_text: str) -> Optional[str]:
"""Kind implied by source markers (mirrors plugins/memory ``_is_memory_provider_dir`` and
plugins/cron_providers ``_is_cron_provider_dir``): memory- or cron-provider markers -> ``exclusive``;
``register_provider`` + ``ProviderProfile`` -> ``model-provider``; else ``None``. Keeps these kinds out
of the general manager's eager import (its PluginContext has no ``register_cron_scheduler``, #62951)."""
if any(marker in source_text for marker in (
"register_memory_provider", "MemoryProvider", "register_cron_scheduler", "CronScheduler")):
return "exclusive"
if "register_provider" in source_text and "ProviderProfile" in source_text:
return "model-provider"
return None
def _read_source_from_origin(origin: Optional[str], limit: int = 8192) -> str:
"""First ``limit`` chars of a module's source (``.pyc`` mapped back to ``.py``); "" on failure."""
try:
if origin and origin.endswith((".pyc", ".pyo")):
origin = importlib.util.source_from_cache(origin)
if not origin or not origin.endswith(".py"):
return ""
return Path(origin).read_text(encoding="utf-8-sig", errors="replace")[:limit]
except Exception:
return ""
def resolve_module_origin(module_name: str) -> Optional[str]:
"""Return a module's source path WITHOUT importing it, or ``None``. ``find_spec`` on a dotted name imports
the parent package, so only the top-level name uses it; remaining segments are walked through
``submodule_search_locations`` by hand. Namespace/zipped/extension modules return ``None``. Shared with
``plugins/memory/__init__.py``."""
parts = [p for p in module_name.split(".") if p]
if not parts:
return None
try:
spec = importlib.util.find_spec(parts[0])
if spec is None or not spec.origin:
return None
if len(parts) == 1:
return spec.origin
search_paths = spec.submodule_search_locations
if not search_paths:
return None
for i, part in enumerate(parts[1:], start=2):
found_origin = next_paths = None
for base in map(Path, search_paths):
pkg_init, mod_file = base / part / "__init__.py", base / (part + ".py")
if pkg_init.is_file():
found_origin, next_paths = str(pkg_init), [base / part]
break
if mod_file.is_file():
found_origin = str(mod_file)
break
if found_origin is None:
return None
if i == len(parts) or next_paths is None:
return found_origin
search_paths = next_paths
return None
except Exception:
return None
def _resolve_module_source(module_name: str, limit: int = 8192) -> str:
"""First ``limit`` chars of a module's source without importing it ("" when unresolvable)."""
return _read_source_from_origin(resolve_module_origin(module_name), limit)
def manifest_key(manifest: "PluginManifest") -> str:
"""Registry id of a manifest: the path-derived ``key`` when set, else the bare ``name``."""
return manifest.key or manifest.name
@dataclass
class PluginManifest:
"""Parsed representation of a plugin.yaml manifest."""
name: str
version: str = ""
description: str = ""
author: str = ""
requires_env: List[Union[str, Dict[str, Any]]] = field(default_factory=list)
provides_tools: List[str] = field(default_factory=list)
provides_hooks: List[str] = field(default_factory=list)
source: str = "" # "bundled", "user", "project", or "entrypoint"
path: Optional[str] = None
# ``standalone`` (default; opt-in via plugins.enabled) | ``backend`` (pluggable backend for a core tool;
# bundled auto-load, user-installed gated) | ``exclusive`` (one active provider, selected via
# <category>.provider; own discovery, general scanner skips) | ``platform`` (gateway adapter; bundled
# auto-load, user-installed gated as untrusted code).
kind: str = "standalone"
# Path-derived registry key used by plugins.enabled/disabled and `hermes plugins list`: ``disk-cleanup``
# for a flat plugin, ``image_gen/openai`` for a category plugin. Empty -> name.
key: str = ""
# Hermes version requirement (``">=0.19"``, comma-separated clauses allowed). Unsatisfied plugins are
# recorded with an error and skipped before import — see ``requires_hermes_error``.
requires_hermes: str = ""
portable: bool = False
skill_namespace: str = ""
# Declared capability ids, normalized to KNOWN ids. Declaration is consent metadata, NOT a grant: live
# only via plugins.entries.<id>.granted_capabilities or the legacy allow_* key.
# See #64228.
capabilities: List[str] = field(default_factory=list)
# Manifest v2 fields — all optional and additive. manifest_version versions the FILE FORMAT (v1 supported
# forever); api_version is the runtime plugin API generation (None = current).
# Absent (v1) manifests are fully supported forever. See #64165.
manifest_version: int = 1
api_version: Optional[int] = None
# Advisory deps [{"id", "version_range"}]: missing ones warn but load; they order the load.
requires_plugins: List[Dict[str, Any]] = field(default_factory=list)
# Declared pip deps — VALIDATED AND SURFACED ONLY, never auto-installed.
# VALIDATED AND SURFACED ONLY — Hermes never auto-installs these (isolation design for the install seam
# is a deferred follow-up; see #64165 round-2 review and #15220).
python_dependencies: List[str] = field(default_factory=list)
# Schema for plugins.entries.<id>.settings; mismatches warn, never fail.
config_schema: Dict[str, Any] = field(default_factory=dict)
license: str = ""
homepage: str = ""
tags: List[str] = field(default_factory=list)
# Event-bus declarations, advisory (discoverability only): ``emits`` bare names published under
# ``<key>:``; ``listens`` fully-qualified ``<plugin>:<event>`` names.
emits: List[str] = field(default_factory=list)
listens: List[str] = field(default_factory=list)
# Language pack declaration: ids whose ``locales/<id>[.tui|.desktop].yaml`` the loader registers
# automatically (no Python needed). ``locale_metadata`` carries the optional per-id
# ``{endonym, rtl}`` from the mapping form of a ``provides_locales`` entry.
provides_locales: List[str] = field(default_factory=list)
locale_metadata: Dict[str, Dict[str, Any]] = field(default_factory=dict)
def parse_provides_locales(raw: Any, key: str = "") -> Tuple[List[str], Dict[str, Dict[str, Any]]]:
"""``provides_locales`` -> (ids, metadata). Entries are ``"pl"`` or ``{id: pl, endonym: Polski, rtl: false}``;
ids are canonicalised (lowercase, ``_`` -> ``-``), invalid or duplicate ones are dropped with a warning."""
from agent.i18n_layers import is_language_id, normalize_language_id
ids: List[str] = []
metadata: Dict[str, Dict[str, Any]] = {}
if raw is None:
return ids, metadata
if isinstance(raw, (str, Mapping)):
raw = [raw]
if not isinstance(raw, list):
logger.warning("Plugin %s: provides_locales must be a list of language ids, got %s", key, type(raw).__name__)
return ids, metadata
for item in raw:
entry_meta: Dict[str, Any] = {}
if isinstance(item, Mapping):
lang_id = normalize_language_id(item.get("id", ""))
if isinstance(item.get("endonym"), str) and item["endonym"].strip():
entry_meta["endonym"] = item["endonym"].strip()
if "rtl" in item:
entry_meta["rtl"] = bool(item["rtl"])
else:
lang_id = normalize_language_id(item)
if not is_language_id(lang_id):
logger.warning("Plugin %s: ignoring invalid provides_locales entry %r", key, item)
continue
if lang_id in ids:
logger.warning("Plugin %s: duplicate provides_locales entry %r", key, lang_id)
continue
ids.append(lang_id)
if entry_meta:
metadata[lang_id] = entry_meta
return ids, metadata
# ── requires_hermes version gate ─────────────────────────────────────────────
_VERSION_COMPARATOR_RE = re.compile(r"^\s*(>=|<=|==|!=|>|<)\s*(.+?)\s*$")
def running_hermes_version() -> str:
"""Base release version of the Hermes code that is running."""
from hermes_cli.version_info import get_version_info
return get_version_info().base_version
_VERSION_SEGMENT_RE = re.compile(r"^\d+")
def _version_tuple(v: str) -> Optional[tuple]:
"""``v1.2.3-rc1`` / ``1.2.3rc1`` / ``1.2.3.post1`` → ``(1, 2, 3)``; ``None`` when a segment has no
leading digits. PEP 440 pre/post/dev suffixes glued to a segment (``0rc1``) are dropped so an rc
*target* still gates and an rc *running* version does not disable every gate."""
parts = re.split(r"[-+]", str(v).strip().lstrip("v"), 1)[0].split(".")
parts += ["0"] * (3 - len(parts))
out = []
for x in parts[:3]:
m = _VERSION_SEGMENT_RE.match(x.strip())
if m is None:
return None
out.append(int(m.group(0)))
return tuple(out)
def version_satisfies(spec: str, current: str) -> bool:
"""``>=``/``>``/``<=``/``<``/``==``/``!=`` clauses (comma = AND; bare version = ``>=``). Unparseable
versions are permissive — no PEP 440 dependency for a one-field manifest gate."""
cur = _version_tuple(current)
if cur is None:
return True
ops = {">=": cur.__ge__, "<=": cur.__le__, "==": cur.__eq__, "!=": cur.__ne__, ">": cur.__gt__, "<": cur.__lt__}
for clause in filter(None, (c.strip() for c in spec.split(","))):
m = _VERSION_COMPARATOR_RE.match(clause)
op, target = (m.group(1), m.group(2)) if m else (">=", clause)
tgt = _version_tuple(target)
if tgt is not None and not ops[op](tgt):
return False
return True
def requires_hermes_error(manifest: "PluginManifest") -> Optional[str]:
"""Load-blocking reason when the manifest's ``requires_hermes`` rejects the running version."""
spec = manifest.get("requires_hermes", "") if isinstance(manifest, Mapping) else manifest.requires_hermes
if not spec:
return None
current = running_hermes_version()
if version_satisfies(spec, current):
return None
return f"requires hermes {spec}, running {current}"
def portable_plugin_manifest(child: Path, source: str, prefix: str) -> PluginManifest:
"""Build the manifest for a portable Agent Plugin directory (``plugin.json``); diagnostics warn."""
from hermes_cli.agent_plugins import read_agent_plugin_manifest
data, diagnostics = read_agent_plugin_manifest(child)
for diagnostic in diagnostics:
logger.warning("Agent Plugin '%s': %s", child, diagnostic.message)
key = f"{prefix}/{child.name}" if prefix else data["name"]
return PluginManifest(
name=data["name"], version=data.get("version", ""), description=data.get("description", ""),
author=_display_author(data.get("author", "")), source=source, path=str(child), key=key,
portable=True, skill_namespace=_portable_skill_namespace(key),
)
def _manifest_kind(data: Mapping, key: str, plugin_dir: Path) -> str:
"""Normalize ``kind``; undeclared memory/model providers are auto-detected from ``__init__.py`` so they
route to their own discovery instead of the general manager."""
raw_kind = data.get("kind", "standalone")
kind = raw_kind.strip().lower() if isinstance(raw_kind, str) else "standalone"
if kind not in _VALID_PLUGIN_KINDS:
logger.warning(
"Plugin %s: unknown kind '%s' (valid: %s); treating as 'standalone'",
key, raw_kind, ", ".join(sorted(_VALID_PLUGIN_KINDS)),
)
kind = "standalone"
init_file = plugin_dir / "__init__.py"
if kind == "standalone" and "kind" not in data and init_file.exists():
with suppress(Exception):
source_text = init_file.read_text(errors="replace", encoding="utf-8-sig")[:8192]
detected = _detect_kind_from_source(source_text)
if detected:
kind = detected
logger.debug("Plugin %s: detected %s, treating as kind='%s'", key, detected, detected)
return kind
def parse_manifest_file(
manifest_file: Path, plugin_dir: Path, source: str, prefix: str
) -> Optional[PluginManifest]:
"""Parse one ``plugin.yaml`` into a :class:`PluginManifest`; ``None`` (warned) on failure."""
try:
if yaml is None:
logger.warning("ruamel.yaml not installed – cannot load %s", manifest_file)
return None
data = fast_safe_load(manifest_file.read_text(encoding="utf-8-sig")) or {}
if not isinstance(data, Mapping):
logger.warning("Failed to parse %s: top level must be a mapping, got %s (#14066)",
manifest_file, type(data).__name__)
return None
name = data.get("name", plugin_dir.name)
key = f"{prefix}/{plugin_dir.name}" if prefix else name
kind = _manifest_kind(data, key, plugin_dir)
logger.debug(
"Parsed manifest: key=%s name=%s kind=%s source=%s path=%s", key, name, kind, source, plugin_dir)
provides_locales, locale_metadata = parse_provides_locales(data.get("provides_locales"), key)
return PluginManifest(
name=name, version=str(data.get("version", "")),
description=data.get("description", ""), author=_display_author(data.get("author", "")),
requires_env=data.get("requires_env", []),
provides_tools=data.get("provides_tools", []),
# ``hooks:`` is the spelling the bundled manifests carried for months; external copies of it
# must keep declaring the same thing (#108371).
provides_hooks=data.get("provides_hooks", data.get("hooks", [])), source=source, path=str(plugin_dir),
kind=kind, key=key, requires_hermes=str(data.get("requires_hermes") or "").strip(),
capabilities=_parse_declared_capabilities(data.get("capabilities"), name),
**_parse_manifest_v2_fields(data, key), emits=data.get("emits") or [],
listens=data.get("listens") or [],
provides_locales=provides_locales, locale_metadata=locale_metadata,
)
except Exception as exc:
logger.warning("Failed to parse %s: %s", manifest_file, exc, exc_info=_plugins_debug())
return None