mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-11-15 18:35:29 +03:00
alt-glitch
389cb74194
A module entry in plugin_api.json also publishes the module's imports (logging, os, sys, Path). The list now names the three functions, and the docs example imports them by name.
13 KiB
13 KiB
sidebar_label, title, description
| sidebar_label | title | description |
|---|---|---|
| Public plugin API | Public plugin API | The Hermes modules and names a plugin may import; hermes plugins validate warns on any other Hermes import |
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.
| Module | Name | Listed from |
|---|---|---|
agent.account_usage |
whole module | developer-guide / plugins docs |
agent.acp_client |
whole module | developer-guide / plugins docs |
agent.browser_page_backend |
BrowserPageBackend |
developer-guide / plugins docs |
agent.browser_provider |
whole module | developer-guide / plugins docs |
agent.context_engine |
whole module | developer-guide / plugins docs |
agent.credential_pool |
whole module | developer-guide / plugins docs |
agent.delegation_backends |
whole module | developer-guide / plugins docs |
agent.delegation_provider |
whole module | developer-guide / plugins docs |
hermes_cli.auth_model_picker |
prompt_model_selection |
developer-guide / plugins docs |
hermes_cli.auth |
resolve_external_process_provider_credentials |
developer-guide / plugins docs |
hermes_cli.model_setup |
whole module | developer-guide / plugins docs |
agent.image_gen_provider |
whole module | developer-guide / plugins docs |
agent.memory_manager |
whole module | developer-guide / plugins docs |
agent.memory_provider |
whole module | developer-guide / plugins docs |
agent.secret_scope |
whole module | developer-guide / plugins docs |
agent.secret_sources.base |
whole module | developer-guide / plugins docs |
agent.subagent_lifecycle |
whole module | developer-guide / plugins docs |
agent.terminal_env_provider |
whole module | developer-guide / plugins docs |
agent.transports |
whole module | developer-guide / plugins docs |
agent.transports.chat_completions |
whole module | developer-guide / plugins docs |
agent.vault_backends.base |
LoginBackend |
developer-guide / plugins docs |
agent.vault_store |
VaultItemMeta |
developer-guide / plugins docs |
agent.video_gen_provider |
whole module | developer-guide / plugins docs |
agent.web_search_provider |
whole module | developer-guide / plugins docs |
cli |
whole module | developer-guide / plugins docs |
gateway.config |
whole module | developer-guide / plugins docs |
gateway.platform_registry |
whole module | developer-guide / plugins docs |
gateway.platforms._shared |
whole module | developer-guide / plugins docs |
gateway.platforms.base |
whole module | developer-guide / plugins docs |
gateway.platforms.event |
whole module | developer-guide / plugins docs |
gateway.platforms.helpers |
whole module | developer-guide / plugins docs |
gateway.status |
whole module | developer-guide / plugins docs |
hermes_cli.auth_oauth_pkce_plugin |
whole module | developer-guide / plugins docs |
hermes_cli.config |
whole module | developer-guide / plugins docs |
hermes_cli.plugin_events |
whole module | developer-guide / plugins docs |
hermes_cli.plugin_provider_requests |
whole module | developer-guide / plugins docs |
hermes_constants |
whole module | developer-guide / plugins docs |
hermes_platform |
whole module | developer-guide / plugins docs |
hermes_state |
whole module | developer-guide / plugins docs |
plugins.plugin_storage |
whole module | developer-guide / plugins docs |
plugins.plugin_utils |
whole module | developer-guide / plugins docs |
pm |
whole module | developer-guide / plugins docs |
providers |
whole module | developer-guide / plugins docs |
providers.base |
whole module | developer-guide / plugins docs |
tools.browser_supervisor |
whole module | developer-guide / plugins docs |
tools.browser_supervisor_capture |
whole module | developer-guide / plugins docs |
tools.computer_use.backend |
whole module | developer-guide / plugins docs |
tools.registry |
whole module | developer-guide / plugins docs |
agent.context_references |
whole module | PluginContext (hermes_cli/plugins_context.py) |
agent.plugin_llm |
whole module | PluginContext (hermes_cli/plugins_context.py) |
agent.transcription_provider |
whole module | PluginContext (hermes_cli/plugins_context.py) |
agent.tts_provider |
whole module | PluginContext (hermes_cli/plugins_context.py) |
cron.execution_identity |
whole module | PluginContext (hermes_cli/plugins_context.py) |
hermes_cli.dashboard_auth |
whole module | PluginContext (hermes_cli/plugins_context.py) |
hermes_cli.platform_actions |
whole module | PluginContext (hermes_cli/plugins_context.py) |
hermes_cli.plugins |
PluginContext |
PluginContext (hermes_cli/plugins_context.py) |
hermes_cli.plugins_ledger |
PluginRegistration |
PluginContext (hermes_cli/plugins_context.py) |
hermes_cli.plugins_state |
PluginState |
PluginContext (hermes_cli/plugins_context.py) |
agent.runtime_cwd |
resolve_agent_cwd |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
agent.usage_pricing |
CostResult |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
hermes_cli.auth_constants |
AuthError |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
tools.environments.base |
BaseEnvironment |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
tools.environments |
BaseEnvironment |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
utils |
atomic_json_write |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
utils |
read_json_or_empty |
prose in memory-provider / model-provider / terminal-environment plugin pages (tools.environments:BaseEnvironment is the package's __all__ re-export) |
gateway.platforms.access_policy_mixin |
OwnAccessPolicyMixin |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.approval |
resolve_gateway_approval |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.approval |
resolve_gateway_approval_card |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.approval_actor |
approval_refusal |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.approval_actor |
refusal_text |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.approval_actor |
slash_confirm_refusal |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.approval_actor |
clarify_refusal |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.approval_actor |
picker_refusal |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.approval_actor |
update_prompt_refusal |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.clarify_gateway |
get_pending |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.clarify_gateway |
resolve_gateway_clarify |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.clarify_gateway |
mark_awaiting_text |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.clarify_gateway |
SKIPPED |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.url_safety |
is_safe_url |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.url_safety |
create_ssrf_safe_async_client |
adding-platform-adapters.md § Public helpers for platform plugins |
tools.url_safety |
create_ssrf_safe_client |
adding-platform-adapters.md § Public helpers for platform plugins |
gateway.platforms._http_client_limits |
platform_httpx_limits |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.gateway_setup_wizard |
print_setup_header |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.gateway_setup_wizard |
confirm_reconfigure |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.gateway_setup_wizard |
offer_home_channel |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.gateway_setup_wizard |
save_env_values |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.gateway_setup_wizard |
prompt_csv |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.setup |
prompt |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.setup |
prompt_choice |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.setup |
prompt_yes_no |
adding-platform-adapters.md § Public helpers for platform plugins |
hermes_cli.cli_output |
whole module | adding-platform-adapters.md § Public helpers for platform plugins |
gateway.platforms.session_model |
SessionModelPickerProvider |
adding-platform-adapters.md § Conversation model settings and picker providers (BasePlatformAdapter) |
gateway.platforms.session_model |
SessionModelSettings |
adding-platform-adapters.md § Conversation model settings and picker providers (BasePlatformAdapter) |
tools.skills_tool |
find_all_skills |
plugins/index.md § Read the skill catalog |
tools.skills_tool |
sort_skills |
plugins/index.md § Read the skill catalog |
tools.skills_tool |
skill_search_dirs |
plugins/index.md § Read the skill catalog |
tools.skills_tool |
locate_skill |
plugins/index.md § Read the skill catalog |
tools.skills_tool |
skill_lookup_path_error |
plugins/index.md § Read the skill catalog |
tools.skills_sync |
dir_hash |
plugins/index.md § Read the skill catalog |
tools.skill_usage |
read_skill_name |
plugins/index.md § Read the skill catalog |
gateway.session_context |
get_session_env |
plugins/index.md § platform plugins: read session identity through the task-local context |
agent.redact |
redact_sensitive_text |
plugin-llm-access.md § From the plugin's frontend: a plugin RPC method (force=True where secrets must never leave) |
hermes_cli.plugin_session |
session_client |
user-guide/features/plugins.md § Plugin code inside the gateway: which client created the session |
agent.file_safety |
get_read_block_error |
plugins/index.md § Check file paths and read YAML with Hermes's own helpers |
agent.file_safety |
raise_if_read_blocked |
plugins/index.md § Check file paths and read YAML with Hermes's own helpers |
agent.file_safety |
is_write_denied |
plugins/index.md § Check file paths and read YAML with Hermes's own helpers |
agent.file_safety |
get_write_denied_error |
plugins/index.md § Check file paths and read YAML with Hermes's own helpers |
hermes_yaml |
safe_load |
plugins/index.md § Check file paths and read YAML with Hermes's own helpers |
hermes_yaml |
safe_dump |
plugins/index.md § Check file paths and read YAML with Hermes's own helpers |
hermes_cli.urllib_security |
open_credentialed_url |
plugins/index.md § Send a credentialed HTTP request without leaking it on redirect |
hermes_cli.chat_launch |
hermes_command |
user-guide/features/plugins.md § A plugin with its own chat client |
hermes_cli.chat_launch |
print_exit_summary |
user-guide/features/plugins.md § A plugin with its own chat client |
hermes_cli.gateway_chat |
shell_client_env |
user-guide/features/plugins.md § A plugin with its own chat client |
hermes_cli.session_worktree |
create |
user-guide/features/plugins.md § A plugin with its own chat client |
hermes_cli.session_worktree |
restore |
user-guide/features/plugins.md § A plugin with its own chat client |
hermes_cli.session_worktree |
finish |
user-guide/features/plugins.md § A plugin with its own chat client |