Hermes BibleUnofficial Docs
← All docs Docs / Developer Guide

Programmatic Integration

Hermes ships three protocols for driving the agent from external programs — IDE plugins, custom UIs, CI pipelines, embedded sub agents. Pick the one that matche

Developer Guide
Section
Developer Guide
Source
hermesbible.com/docs/developer-guide/programmatic-integration

Hermes ships three protocols for driving the agent from external programs — IDE plugins, custom UIs, CI pipelines, embedded sub agents. Pick the one that matche

Excerpt from the official Hermes Agent documentation, quoted for reference. View source

What this page covers

Section outline mirrored from the official Hermes Agent documentation. Follow any heading to read the complete text on the source site.

Upstream outline

  1. ACP (Agent Client Protocol)
  2. TUI Gateway JSON-RPC
  3. Method catalog (selected)
  4. Events streamed back
  5. Pi-style RPC mapping
  6. OpenAI-Compatible API Server
  7. Which one should I use?
  8. Model hot-swapping
  9. A note on --mode rpc

Section map

ACP (Agent Client Protocol)

Maps acp (agent client protocol) to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

TUI Gateway JSON-RPC

Maps tui gateway json-rpc to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Method catalog (selected)

Maps method catalog (selected) to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Events streamed back

Maps events streamed back to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Pi-style RPC mapping

Maps pi-style rpc mapping to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

OpenAI-Compatible API Server

Maps openai-compatible api server to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Which one should I use?

Maps which one should i use? to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Model hot-swapping

Maps model hot-swapping to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Implementation notes

  • Use this Developer Guide doc as a navigation page first: the local clone mirrors the source structure and links each heading back to the authoritative upstream section.
  • Primary decision areas: ACP (Agent Client Protocol), TUI Gateway JSON-RPC, Method catalog (selected), Events streamed back, Pi-style RPC mapping. Read those source anchors before changing installs, credentials, automation, or runtime configuration.
  • Useful search signals for this doc: programmatic, integration, ships, three, protocols. These are derived from the public title and summary so the clone remains lightweight.

Decision table

Best fitDeveloper Guide documentation

Use when you need orientation for programmatic integration before applying exact upstream commands.

Verify firstACP (Agent Client Protocol)

Open the source anchor for ACP (Agent Client Protocol) and confirm platform-specific requirements before changing configuration.

Escalate to sourceCommands, credentials, runtime behavior

Use the upstream page as the authority for current syntax, release changes, and security-sensitive steps.

Verification checklist

  1. Use this page to orient yourself within Developer Guide, then open the linked source page for exact current syntax.
  2. Start with the source section for ACP (Agent Client Protocol); do not rely on the local summary for commands or secrets.
  3. Check platform, install method, provider, and credential assumptions before changing a real environment.
  4. Review the source section for TUI Gateway JSON-RPC if the page involves setup, automation, messaging, or runtime behavior.
  5. After applying anything from the source, run the smallest relevant smoke test before widening scope.

Risk notes

Automation

Start with a bounded dry run, logs, and a manual stop path before enabling recurring or unattended execution.

Model spend

Set provider, token, and retry limits before scaling the workflow beyond a single test run.

Runtime access

Check filesystem, shell, browser, repository, and server permissions before granting the agent write access.

What this page covers

  • Core concept and where it fits in the Hermes Agent system.
  • Setup or operating context implied by the upstream page summary.
  • The source page link for full current details and updates.

Source mirror note

This page is generated from the public Hermes Bible index so the clone has the same route coverage and search surface. It stores the public title, category, summary, and source link locally; use the source page for full upstream text and updates.

Open source page