Skip to main content

Public plugin API

These are the Hermes modules and names a plugin may import. hermes plugins validate reads the same list (hermes_cli/data/plugin_api.json) and warns, without failing, on any other import of a Hermes module (catalog rule 9: public surfaces only). Imports of the standard library, third-party packages, the plugin's own modules, and imports under if TYPE_CHECKING: are never flagged.

A module row allows the module and every name in it that does not start with an underscore. A row with a name allows that one name only.

ModuleNameListed from
agent.account_usagewhole moduledeveloper-guide / plugins docs
agent.acp_clientwhole moduledeveloper-guide / plugins docs
agent.browser_providerwhole moduledeveloper-guide / plugins docs
agent.context_enginewhole moduledeveloper-guide / plugins docs
agent.credential_poolwhole moduledeveloper-guide / plugins docs
agent.delegation_backendswhole moduledeveloper-guide / plugins docs
agent.delegation_providerwhole moduledeveloper-guide / plugins docs
hermes_cli.auth_model_pickerprompt_model_selectiondeveloper-guide / plugins docs
hermes_cli.authresolve_external_process_provider_credentialsdeveloper-guide / plugins docs
hermes_cli.model_setupwhole moduledeveloper-guide / plugins docs
agent.image_gen_providerwhole moduledeveloper-guide / plugins docs
agent.memory_managerwhole moduledeveloper-guide / plugins docs
agent.memory_providerwhole moduledeveloper-guide / plugins docs
agent.secret_scopewhole moduledeveloper-guide / plugins docs
agent.secret_sources.basewhole moduledeveloper-guide / plugins docs
agent.subagent_lifecyclewhole moduledeveloper-guide / plugins docs
agent.terminal_env_providerwhole moduledeveloper-guide / plugins docs
agent.transportswhole moduledeveloper-guide / plugins docs
agent.transports.chat_completionswhole moduledeveloper-guide / plugins docs
agent.video_gen_providerwhole moduledeveloper-guide / plugins docs
agent.web_search_providerwhole moduledeveloper-guide / plugins docs
cliwhole moduledeveloper-guide / plugins docs
gateway.configwhole moduledeveloper-guide / plugins docs
gateway.platform_registrywhole moduledeveloper-guide / plugins docs
gateway.platforms._sharedwhole moduledeveloper-guide / plugins docs
gateway.platforms.basewhole moduledeveloper-guide / plugins docs
gateway.platforms.eventwhole moduledeveloper-guide / plugins docs
gateway.platforms.helperswhole moduledeveloper-guide / plugins docs
gateway.statuswhole moduledeveloper-guide / plugins docs
hermes_cli.auth_oauth_pkce_pluginwhole moduledeveloper-guide / plugins docs
hermes_cli.configwhole moduledeveloper-guide / plugins docs
hermes_cli.plugin_eventswhole moduledeveloper-guide / plugins docs
hermes_cli.plugin_provider_requestswhole moduledeveloper-guide / plugins docs
hermes_constantswhole moduledeveloper-guide / plugins docs
hermes_platformwhole moduledeveloper-guide / plugins docs
hermes_statewhole moduledeveloper-guide / plugins docs
plugins.plugin_storagewhole moduledeveloper-guide / plugins docs
plugins.plugin_utilswhole moduledeveloper-guide / plugins docs
pmwhole moduledeveloper-guide / plugins docs
providerswhole moduledeveloper-guide / plugins docs
providers.basewhole moduledeveloper-guide / plugins docs
tools.browser_supervisorwhole moduledeveloper-guide / plugins docs
tools.browser_supervisor_capturewhole moduledeveloper-guide / plugins docs
tools.computer_use.backendwhole moduledeveloper-guide / plugins docs
tools.registrywhole moduledeveloper-guide / plugins docs
agent.context_referenceswhole modulePluginContext (hermes_cli/plugins.py)
agent.plugin_llmwhole modulePluginContext (hermes_cli/plugins.py)
agent.transcription_providerwhole modulePluginContext (hermes_cli/plugins.py)
agent.tts_providerwhole modulePluginContext (hermes_cli/plugins.py)
cron.execution_identitywhole modulePluginContext (hermes_cli/plugins.py)
hermes_cli.dashboard_authwhole modulePluginContext (hermes_cli/plugins.py)
hermes_cli.platform_actionswhole modulePluginContext (hermes_cli/plugins.py)
hermes_cli.pluginsPluginContextPluginContext (hermes_cli/plugins.py)
hermes_cli.plugins_ledgerPluginRegistrationPluginContext (hermes_cli/plugins.py)
hermes_cli.plugins_statePluginStatePluginContext (hermes_cli/plugins.py)
agent.runtime_cwdresolve_agent_cwdprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
agent.usage_pricingCostResultprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
hermes_cli.auth_constantsAuthErrorprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
tools.environments.baseBaseEnvironmentprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
tools.environmentsBaseEnvironmentprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
utilsatomic_json_writeprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
utilsread_json_or_emptyprose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export)
gateway.platforms.access_policy_mixinOwnAccessPolicyMixinadding-platform-adapters.md § Public helpers for platform plugins
tools.approvalresolve_gateway_approvaladding-platform-adapters.md § Public helpers for platform plugins
tools.approvalresolve_gateway_approval_cardadding-platform-adapters.md § Public helpers for platform plugins
tools.clarify_gatewayget_pendingadding-platform-adapters.md § Public helpers for platform plugins
tools.clarify_gatewayresolve_gateway_clarifyadding-platform-adapters.md § Public helpers for platform plugins
tools.clarify_gatewaymark_awaiting_textadding-platform-adapters.md § Public helpers for platform plugins
tools.clarify_gatewaySKIPPEDadding-platform-adapters.md § Public helpers for platform plugins
tools.url_safetyis_safe_urladding-platform-adapters.md § Public helpers for platform plugins
tools.url_safetycreate_ssrf_safe_async_clientadding-platform-adapters.md § Public helpers for platform plugins
gateway.platforms._http_client_limitsplatform_httpx_limitsadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.gateway_setup_wizardprint_setup_headeradding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.gateway_setup_wizardconfirm_reconfigureadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.gateway_setup_wizardoffer_home_channeladding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.gateway_setup_wizardsave_env_valuesadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.gateway_setup_wizardprompt_csvadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.setuppromptadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.setupprompt_choiceadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.setupprompt_yes_noadding-platform-adapters.md § Public helpers for platform plugins
hermes_cli.cli_outputwhole moduleadding-platform-adapters.md § Public helpers for platform plugins
tools.skills_toolfind_all_skillsplugins/index.md § Read the skill catalog
tools.skills_toolsort_skillsplugins/index.md § Read the skill catalog
tools.skills_toolskill_search_dirsplugins/index.md § Read the skill catalog
tools.skills_toollocate_skillplugins/index.md § Read the skill catalog
tools.skills_toolskill_lookup_path_errorplugins/index.md § Read the skill catalog
tools.skills_syncdir_hashplugins/index.md § Read the skill catalog
tools.skill_usageread_skill_nameplugins/index.md § Read the skill catalog
gateway.session_contextget_session_envplugins/index.md § platform plugins: read session identity through the task-local context