Skip to main content

Hermes bus integration plugin — auto-start, auto-register, message injection, bus tools

Project description

hermes-bus-plugin

English | 中文

Hermes Agent plugin for message bus integration — lifecycle management, external message injection, bus tools.

A thin integration layer between Hermes Agent and the hermes-bus / hermes-notify packages.

Install

# Via Hermes plugin manager
hermes plugins install hermes-bus-plugin

# Or copy to ~/.hermes/hermes-agent/plugins/
cp -r hermes-bus-plugin ~/.hermes/hermes-agent/plugins/
hermes plugins enable hermes-bus-plugin

Session Naming

Each CLI window registers a unique bus endpoint on startup. The default endpoint is hermes-bus (first session), with hermes-bus-2, hermes-bus-3, etc. for additional sessions. To give your session a stable name that survives reconnection:

/title my-agent-name

The plugin uses the title set by /title as the bus endpoint name.

Action When Description
Start bus daemon Plugin load Ensures hermes-bus is running
Register listener Plugin load Opens a bus endpoint for incoming messages
Print notifications On bus message print: true → terminal (only when context is NOT true)
Inject context + push On bus message context: true → inject into LLM context + push to Agent via pending_input (overrides print, token-heavy — use sparingly)

Provided Tools

bus_send — send a message through the bus to any endpoint:

bus_send(target="notifier", type="progress", text="50% done")

bus_status — check bus health and connected endpoints:

bus_status()

bus_info — show current session's bus connection details:

bus_info()

Route Rules

Messages arriving at the bus are matched against ~/.hermes/bus-rules.yaml rules. Each rule can trigger three independent actions:

Field Behavior Default
print Print to terminal false
print_format Template or script for terminal output {text}
context Inject into LLM context + push to Agent false
context_format Template or script for context/push text {text}
command Execute shell command (audio, script, etc.) none

Priority Logic

context and print are mutually exclusive:

  • context: true → inject context + push to Agent (print is ignored). ⚠️ Token-heavy — each push triggers an Agent turn.
  • print: true → terminal output only (only when context is NOT true)
  • command → always executed if defined, independent of context/print

Format Templates

print_format and context_format support these placeholders:

Placeholder Description
{from} Sender endpoint name
{text} Message body text
{type} Message type
{ts} Unix timestamp (raw)
{ts:%Y-%m-%d %H:%M:%S} strftime formatted
{color:cyan} ANSI foreground color (black/red/green/yellow/blue/magenta/cyan/white)
{color:bold_green} Bold color variant
{bold} Bold text
{reset} Reset all styles

Script Support

If print_format or context_format starts with ~ or / and points to an executable file, the script is run with FROM, TYPE, TEXT as environment variables and its stdout is used as the rendered output (supports ANSI colors).

#!/bin/bash
# format-notify.sh — example format script
GREEN="\033[1;32m"
YELLOW="\033[1;33m"
RESET="\033[0m"

case "$TYPE" in
  task_done)  echo -e "${GREEN}${FROM}${RESET}${TEXT}" ;;
  task_error) echo -e "${YELLOW}${FROM} failed${RESET}\n   ${TEXT}" ;;
  *)          echo -e "${FROM}: ${TEXT}" ;;
esac
# bus-rules.yaml
- match_type: task_done
  print: true
  print_format: "~/scripts/format-notify.sh"

Example Rules

callbacks:
  # Notification only (no context)
  - match_type: ack
    print: true
    print_format: "{color:cyan}📬 {from}{reset}  {text}  [{ts:%H:%M}]"
    context: false

  # Silent context injection
  - match_type: progress
    print: false
    context: true

  # Context + terminal + audio
  - match_type: task_done
    print: true
    print_format: "{color:bold_green}✔ {from}{reset}  {text}  {color:cyan}[{ts:%H:%M:%S}]{reset}"
    context: true
    command: "afplay ~/sounds/done.mp3"

Requirements

  • hermes-bus (pip)
  • hermes-notify (pip)

Both are auto-detected — the plugin degrades gracefully if they're missing.

Architecture

External process ──→ hermes-bus ──→ hermes-bus-plugin ──→ LLM context
                        (socket)        (pre_llm_call hook)
                        
Hermes session ──→ bus_send tool ──→ hermes-bus ──→ target endpoint

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hermes_bus_plugin-0.4.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hermes_bus_plugin-0.4.0-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file hermes_bus_plugin-0.4.0.tar.gz.

File metadata

  • Download URL: hermes_bus_plugin-0.4.0.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for hermes_bus_plugin-0.4.0.tar.gz
Algorithm Hash digest
SHA256 239a98242a74296711520a94933e3340a34a470a1840bfd4461e04f66f5f4d37
MD5 d61a1298052a78fdb6e635e6dd4c012c
BLAKE2b-256 4c46f415511649d7acfa957766f9ddf14ca88a1c013c5694d74d54f6e04c63ac

See more details on using hashes here.

File details

Details for the file hermes_bus_plugin-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hermes_bus_plugin-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9a4f2e9d89df962d6252f77f72dea0dcce5000708184acf06ee99548ff9a873
MD5 189683cca950d2b08747eca1ae7830bf
BLAKE2b-256 ce29c415a7c4839453f6992160b6d67fe57524aab2b45d8c7779598257f662ab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page