mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-03 09:17:09 +08:00
Broad drift audit against origin/main (b52b63396).
Reference pages (most user-visible drift):
- slash-commands: add /busy, /curator, /footer, /indicator, /redraw, /steer
that were missing; drop non-existent /terminal-setup; fix /q footnote
(resolves to /queue, not /quit); extend CLI-only list with all 24
CLI-only commands in the registry
- cli-commands: add dedicated sections for hermes curator / fallback /
hooks (new subcommands not previously documented); remove stale
hermes honcho standalone section (the plugin registers dynamically
via hermes memory); list curator/fallback/hooks in top-level table;
fix completion to include fish
- toolsets-reference: document the real 52-toolset count; split browser
vs browser-cdp; add discord / discord_admin / spotify / yuanbao;
correct hermes-cli tool count from 36 to 38; fix misleading claim
that hermes-homeassistant adds tools (it's identical to hermes-cli)
- tools-reference: bump tool count 55 -> 68; add 7 Spotify, 5 Yuanbao,
2 Discord toolsets; move browser_cdp/browser_dialog to their own
browser-cdp toolset section
- environment-variables: add 40+ user-facing HERMES_* vars that were
undocumented (--yolo, --accept-hooks, --ignore-*, inference model
override, agent/stream/checkpoint timeouts, OAuth trace, per-platform
batch tuning for Telegram/Discord/Matrix/Feishu/WeCom, cron knobs,
gateway restart/connect timeouts); dedupe the Cron Scheduler section;
replace stale QQ_SANDBOX with QQ_PORTAL_HOST
User-guide (top level):
- cli.md: compression preserves last 20 turns, not 4 (protect_last_n: 20)
- configuration.md: display.platforms is the canonical per-platform
override key; tool_progress_overrides is deprecated and auto-migrated
- profiles.md: model.default is the config key, not model.model
- sessions.md: CLI/TUI session IDs use 6-char hex, gateway uses 8
- checkpoints-and-rollback.md: destructive-command list now matches
_DESTRUCTIVE_PATTERNS (adds rmdir, cp, install, dd)
- docker.md: the container runs as non-root hermes (UID 10000) via
gosu; fix install command (uv pip); add missing --insecure on the
dashboard compose example (required for non-loopback bind)
- security.md: systemctl danger pattern also matches 'restart'
- index.md: built-in tool count 47 -> 68
- integrations/index.md: 6 STT providers, 8 memory providers
- integrations/providers.md: drop fictional dashscope/qwen aliases
Features:
- overview.md: 9 image models (not 8), 9 TTS providers (not 5),
8 memory providers (Supermemory was missing)
- tool-gateway.md: 9 image models
- tools.md: extend common-toolsets list with search / messaging /
spotify / discord / debugging / safe
- fallback-providers.md: add 6 real providers from PROVIDER_REGISTRY
(lmstudio, kimi-coding-cn, stepfun, alibaba-coding-plan,
tencent-tokenhub, azure-foundry)
- plugins.md: Available Hooks table now includes on_session_finalize,
on_session_reset, subagent_stop
- built-in-plugins.md: add the 7 bundled plugins the page didn't
mention (spotify, google_meet, three image_gen providers, two
dashboard examples)
- web-dashboard.md: add --insecure and --tui flags
- cron.md: hermes cron create takes positional schedule/prompt, not
flags
Messaging:
- telegram.md: TELEGRAM_WEBHOOK_SECRET is now REQUIRED when
TELEGRAM_WEBHOOK_URL is set (gateway refuses to start without it
per GHSA-3vpc-7q5r-276h). Biggest user-visible drift in the batch.
- discord.md: HERMES_DISCORD_TEXT_BATCH_SPLIT_DELAY_SECONDS default
is 2.0, not 0.1
- dingtalk.md: document DINGTALK_REQUIRE_MENTION /
FREE_RESPONSE_CHATS / MENTION_PATTERNS / HOME_CHANNEL /
ALLOW_ALL_USERS that the adapter supports
- bluebubbles.md: drop fictional BLUEBUBBLES_SEND_READ_RECEIPTS env
var; the setting lives in platforms.bluebubbles.extra only
- qqbot.md: drop dead QQ_SANDBOX; add real QQ_PORTAL_HOST and
QQ_GROUP_ALLOWED_USERS
- wecom-callback.md: replace 'hermes gateway start' (service-only)
with 'hermes gateway' for first-time setup
Developer-guide:
- architecture.md: refresh tool/toolset counts (61/52), terminal
backend count (7), line counts for run_agent.py (~13.7k), cli.py
(~11.5k), main.py (~10.4k), setup.py (~3.5k), gateway/run.py
(~12.2k), mcp_tool.py (~3.1k); add yuanbao adapter, bump platform
adapter count 18 -> 20
- agent-loop.md: run_agent.py line count 10.7k -> 13.7k
- tools-runtime.md: add vercel_sandbox backend
- adding-tools.md: remove stale 'Discovery import added to
model_tools.py' checklist item (registry auto-discovery)
- adding-platform-adapters.md: mark send_typing / get_chat_info as
concrete base methods; only connect/disconnect/send are abstract
- acp-internals.md: ACP sessions now persist to SessionDB
(~/.hermes/state.db); acp.run_agent call uses
use_unstable_protocol=True
- cron-internals.md: gateway runs scheduler in a dedicated background
thread via _start_cron_ticker, not on a maintenance cycle; locking
is cross-process via fcntl.flock (Unix) / msvcrt.locking (Windows)
- gateway-internals.md: gateway/run.py ~12k lines
- provider-runtime.md: cron DOES support fallback (run_job reads
fallback_providers from config)
- session-storage.md: SCHEMA_VERSION = 11 (not 9); add migrations
10 and 11 (trigram FTS, inline-mode FTS5 re-index); add
api_call_count column to Sessions DDL; document messages_fts_trigram
and state_meta in the architecture tree
- context-compression-and-caching.md: remove the obsolete 'context
pressure warnings' section (warnings were removed for causing
models to give up early)
- context-engine-plugin.md: compress() signature now includes
focus_topic param
- extending-the-cli.md: _build_tui_layout_children signature now
includes model_picker_widget; add to default layout
Also fixed three pre-existing broken links/anchors the build warned
about (docker.md -> api-server.md, yuanbao.md -> cron-jobs.md and
tips#background-tasks, nix-setup.md -> #container-aware-cli).
Regenerated per-skill pages via website/scripts/generate-skill-docs.py
so catalog tables and sidebar are consistent with current SKILL.md
frontmatter.
docusaurus build: clean, no broken links or anchors.
227 lines
12 KiB
Markdown
227 lines
12 KiB
Markdown
---
|
||
sidebar_position: 12
|
||
sidebar_label: "Built-in Plugins"
|
||
title: "Built-in Plugins"
|
||
description: "Plugins shipped with Hermes Agent that run automatically via lifecycle hooks — disk-cleanup and friends"
|
||
---
|
||
|
||
# Built-in Plugins
|
||
|
||
Hermes ships a small set of plugins bundled with the repository. They live under `<repo>/plugins/<name>/` and load automatically alongside user-installed plugins in `~/.hermes/plugins/`. They use the same plugin surface as third-party plugins — hooks, tools, slash commands — just maintained in-tree.
|
||
|
||
See the [Plugins](/docs/user-guide/features/plugins) page for the general plugin system, and [Build a Hermes Plugin](/docs/guides/build-a-hermes-plugin) to write your own.
|
||
|
||
## How discovery works
|
||
|
||
The `PluginManager` scans four sources, in order:
|
||
|
||
1. **Bundled** — `<repo>/plugins/<name>/` (what this page documents)
|
||
2. **User** — `~/.hermes/plugins/<name>/`
|
||
3. **Project** — `./.hermes/plugins/<name>/` (requires `HERMES_ENABLE_PROJECT_PLUGINS=1`)
|
||
4. **Pip entry points** — `hermes_agent.plugins`
|
||
|
||
On name collision, later sources win — a user plugin named `disk-cleanup` would replace the bundled one.
|
||
|
||
`plugins/memory/` and `plugins/context_engine/` are deliberately excluded from bundled scanning. Those directories use their own discovery paths because memory providers and context engines are single-select providers configured through `hermes memory setup` / `context.engine` in config.
|
||
|
||
## Bundled plugins are opt-in
|
||
|
||
Bundled plugins ship disabled. Discovery finds them (they appear in `hermes plugins list` and the interactive `hermes plugins` UI), but none load until you explicitly enable them:
|
||
|
||
```bash
|
||
hermes plugins enable disk-cleanup
|
||
```
|
||
|
||
Or via `~/.hermes/config.yaml`:
|
||
|
||
```yaml
|
||
plugins:
|
||
enabled:
|
||
- disk-cleanup
|
||
```
|
||
|
||
This is the same mechanism user-installed plugins use. Bundled plugins are never auto-enabled — not on fresh install, not for existing users upgrading to a newer Hermes. You always opt in explicitly.
|
||
|
||
To turn a bundled plugin off again:
|
||
|
||
```bash
|
||
hermes plugins disable disk-cleanup
|
||
# or: remove it from plugins.enabled in config.yaml
|
||
```
|
||
|
||
## Currently shipped
|
||
|
||
The repo ships these bundled plugins under `plugins/`. All are opt-in — enable them via `hermes plugins enable <name>`.
|
||
|
||
| Plugin | Kind | Purpose |
|
||
|---|---|---|
|
||
| `disk-cleanup` | hooks + slash command | Auto-track ephemeral files and clean them on session end |
|
||
| `observability/langfuse` | hooks | Trace turns / LLM calls / tools to [Langfuse](https://langfuse.com) |
|
||
| `spotify` | backend (7 tools) | Native Spotify playback, queue, search, playlists, albums, library |
|
||
| `google_meet` | standalone | Join Meet calls, live-caption transcription, optional realtime duplex audio |
|
||
| `image_gen/openai` | image backend | OpenAI `gpt-image-2` image generation backend (alternative to FAL) |
|
||
| `image_gen/openai-codex` | image backend | OpenAI image generation via Codex OAuth |
|
||
| `image_gen/xai` | image backend | xAI `grok-2-image` backend |
|
||
| `example-dashboard` | dashboard example | Reference dashboard plugin for [Extending the Dashboard](./extending-the-dashboard.md) |
|
||
| `strike-freedom-cockpit` | dashboard skin | Sample custom dashboard skin |
|
||
|
||
Memory providers (`plugins/memory/*`) and context engines (`plugins/context_engine/*`) are listed separately on [Memory Providers](./memory-providers.md) — they're managed through `hermes memory` and `hermes plugins` respectively. The full per-plugin detail for the two long-running hooks-based plugins follows.
|
||
|
||
### disk-cleanup
|
||
|
||
Auto-tracks and removes ephemeral files created during sessions — test scripts, temp outputs, cron logs, stale chrome profiles — without requiring the agent to remember to call a tool.
|
||
|
||
**How it works:**
|
||
|
||
| Hook | Behaviour |
|
||
|---|---|
|
||
| `post_tool_call` | When `write_file` / `terminal` / `patch` creates a file matching `test_*`, `tmp_*`, or `*.test.*` inside `HERMES_HOME` or `/tmp/hermes-*`, track it silently as `test` / `temp` / `cron-output`. |
|
||
| `on_session_end` | If any test files were auto-tracked during the turn, run the safe `quick` cleanup and log a one-line summary. Stays silent otherwise. |
|
||
|
||
**Deletion rules:**
|
||
|
||
| Category | Threshold | Confirmation |
|
||
|---|---|---|
|
||
| `test` | every session end | Never |
|
||
| `temp` | >7 days since tracked | Never |
|
||
| `cron-output` | >14 days since tracked | Never |
|
||
| empty dirs under HERMES_HOME | always | Never |
|
||
| `research` | >30 days, beyond 10 newest | Always (deep only) |
|
||
| `chrome-profile` | >14 days since tracked | Always (deep only) |
|
||
| files >500 MB | never auto | Always (deep only) |
|
||
|
||
**Slash command** — `/disk-cleanup` available in both CLI and gateway sessions:
|
||
|
||
```
|
||
/disk-cleanup status # breakdown + top-10 largest
|
||
/disk-cleanup dry-run # preview without deleting
|
||
/disk-cleanup quick # run safe cleanup now
|
||
/disk-cleanup deep # quick + list items needing confirmation
|
||
/disk-cleanup track <path> <category> # manual tracking
|
||
/disk-cleanup forget <path> # stop tracking (does not delete)
|
||
```
|
||
|
||
**State** — everything lives at `$HERMES_HOME/disk-cleanup/`:
|
||
|
||
| File | Contents |
|
||
|---|---|
|
||
| `tracked.json` | Tracked paths with category, size, and timestamp |
|
||
| `tracked.json.bak` | Atomic-write backup of the above |
|
||
| `cleanup.log` | Append-only audit trail of every track / skip / reject / delete |
|
||
|
||
**Safety** — cleanup only ever touches paths under `HERMES_HOME` or `/tmp/hermes-*`. Windows mounts (`/mnt/c/...`) are rejected. Well-known top-level state dirs (`logs/`, `memories/`, `sessions/`, `cron/`, `cache/`, `skills/`, `plugins/`, `disk-cleanup/` itself) are never removed even when empty — a fresh install does not get gutted on first session end.
|
||
|
||
**Enabling:** `hermes plugins enable disk-cleanup` (or check the box in `hermes plugins`).
|
||
|
||
**Disabling again:** `hermes plugins disable disk-cleanup`.
|
||
|
||
### observability/langfuse
|
||
|
||
Traces Hermes turns, LLM calls, and tool invocations to [Langfuse](https://langfuse.com) — an open-source LLM observability platform. One span per turn, one generation per API call, one tool observation per tool call. Usage totals, per-type token counts, and cost estimates come out of Hermes' canonical `agent.usage_pricing` numbers, so the Langfuse dashboard sees the same breakdown (input / output / `cache_read_input_tokens` / `cache_creation_input_tokens` / `reasoning_tokens`) that appears in `hermes logs`.
|
||
|
||
The plugin is fail-open: no SDK installed, no credentials, or a transient Langfuse error — all turn into a silent no-op in the hook. The agent loop is never impacted.
|
||
|
||
**Setup (interactive — recommended):**
|
||
|
||
```bash
|
||
hermes tools # → Langfuse Observability → Cloud or Self-Hosted
|
||
```
|
||
|
||
The wizard collects your keys, `pip install`s the `langfuse` SDK, and adds `observability/langfuse` to `plugins.enabled` for you. Restart Hermes and the next turn ships a trace.
|
||
|
||
**Setup (manual):**
|
||
|
||
```bash
|
||
pip install langfuse
|
||
hermes plugins enable observability/langfuse
|
||
```
|
||
|
||
Then put the credentials in `~/.hermes/.env`:
|
||
|
||
```bash
|
||
HERMES_LANGFUSE_PUBLIC_KEY=pk-lf-...
|
||
HERMES_LANGFUSE_SECRET_KEY=sk-lf-...
|
||
HERMES_LANGFUSE_BASE_URL=https://cloud.langfuse.com # or your self-hosted URL
|
||
```
|
||
|
||
**How it works:**
|
||
|
||
| Hook | Behaviour |
|
||
|---|---|
|
||
| `pre_api_request` / `pre_llm_call` | Open (or reuse) a per-turn root span "Hermes turn". Start a `generation` child observation for this API call with serialized recent messages as input. |
|
||
| `post_api_request` / `post_llm_call` | Close the generation, attach `usage_details`, `cost_details`, `finish_reason`, assistant output + tool calls. If no tool calls and non-empty content, close the turn. |
|
||
| `pre_tool_call` | Start a `tool` child observation with sanitized `args`. |
|
||
| `post_tool_call` | Close the tool observation with sanitized `result`. `read_file` payloads get summarized (head + tail + omitted-line count) so a huge file read stays under `HERMES_LANGFUSE_MAX_CHARS`. |
|
||
|
||
Session grouping keys off the Hermes session ID (or task ID for sub-agents) via `langfuse.propagate_attributes`, so everything in a single `hermes chat` session lives under one Langfuse session.
|
||
|
||
**Verify:**
|
||
|
||
```bash
|
||
hermes plugins list # observability/langfuse should show "enabled"
|
||
hermes chat -q "hello" # check the Langfuse UI for a "Hermes turn" trace
|
||
```
|
||
|
||
**Optional tuning** (in `.env`):
|
||
|
||
| Variable | Default | Purpose |
|
||
|---|---|---|
|
||
| `HERMES_LANGFUSE_ENV` | — | Environment tag on traces (`production`, `staging`, …) |
|
||
| `HERMES_LANGFUSE_RELEASE` | — | Release/version tag |
|
||
| `HERMES_LANGFUSE_SAMPLE_RATE` | `1.0` | Sampling rate passed to the SDK (0.0–1.0) |
|
||
| `HERMES_LANGFUSE_MAX_CHARS` | `12000` | Per-field truncation for message content / tool args / tool results |
|
||
| `HERMES_LANGFUSE_DEBUG` | `false` | Verbose plugin logging to `agent.log` |
|
||
|
||
Hermes-prefixed and standard SDK env vars (`LANGFUSE_PUBLIC_KEY`, `LANGFUSE_SECRET_KEY`, `LANGFUSE_BASE_URL`) are both accepted — Hermes-prefixed wins when both are set.
|
||
|
||
**Performance:** the Langfuse client is cached after the first hook call. If credentials or SDK are missing, that decision is also cached — subsequent hooks fast-return without re-checking env vars or reloading config.
|
||
|
||
**Disabling:** `hermes plugins disable observability/langfuse`. The plugin module is still discovered, but no module code runs until you re-enable.
|
||
|
||
### google_meet
|
||
|
||
Lets the agent **join, transcribe, and participate in Google Meet calls** — take notes on a meeting, summarize the back-and-forth after, follow up on specific points, and (optionally) speak replies back into the call via TTS.
|
||
|
||
**What it adds:**
|
||
|
||
- A headless virtual participant that joins a Meet URL using browser automation
|
||
- Live transcription of the meeting audio via the configured STT provider
|
||
- A `meet_summarize` / `meet_speak` / `meet_followup` toolset the agent invokes to act on what it heard
|
||
- Post-meeting artifacts (transcript, speaker-attributed notes, action items) saved under `~/.hermes/cache/google_meet/<meeting_id>/`
|
||
|
||
**Setup:**
|
||
|
||
```bash
|
||
hermes plugins enable google_meet
|
||
# Prompts you to sign in via the plugin's OAuth flow on first use —
|
||
# needs a Google account with Meet access. Host approval may be required
|
||
# if the meeting enforces "only invited participants can join".
|
||
```
|
||
|
||
Usage from chat:
|
||
|
||
> "Join meet.google.com/abc-defg-hij and take notes. After the call, send me a summary with action items."
|
||
|
||
The agent kicks off the meeting join, streams the transcription back into its context as the call proceeds, and produces a structured summary when the meeting ends (or when you tell it to stop).
|
||
|
||
**When to use it:** recurring standups where you want a bot to transcribe + summarize for async attendees; deposition-style interviews where you want structured notes; any case where you'd otherwise need Fireflies / Otter / Grain. When you'd rather not have an AI listening in — don't enable it.
|
||
|
||
**Disabling:** `hermes plugins disable google_meet`. Any cached transcripts and recordings stay in `~/.hermes/cache/google_meet/` until you remove them.
|
||
|
||
## Adding a bundled plugin
|
||
|
||
Bundled plugins are written exactly like any other Hermes plugin — see [Build a Hermes Plugin](/docs/guides/build-a-hermes-plugin). The only differences are:
|
||
|
||
- Directory lives at `<repo>/plugins/<name>/` instead of `~/.hermes/plugins/<name>/`
|
||
- Manifest source is reported as `bundled` in `hermes plugins list`
|
||
- User plugins with the same name override the bundled version
|
||
|
||
A plugin is a good candidate for bundling when:
|
||
|
||
- It has no optional dependencies (or they're already `pip install .[all]` deps)
|
||
- The behaviour benefits most users and is opt-out rather than opt-in
|
||
- The logic ties into lifecycle hooks that the agent would otherwise have to remember to invoke
|
||
- It complements a core capability without expanding the model-visible tool surface
|
||
|
||
Counter-examples — things that should stay as user-installable plugins, not bundled: third-party integrations with API keys, niche workflows, large dependency trees, anything that would meaningfully change agent behaviour by default.
|