Hermes BibleUnofficial Docs
← All docs Docs / Developer Guide

Adding Providers

Hermes can already talk to any OpenAI compatible endpoint through the custom provider path. Do not add a built in provider unless you want first class UX for th

Developer Guide
Section
Developer Guide
Source
hermesbible.com/docs/developer-guide/adding-providers

Hermes can already talk to any OpenAI compatible endpoint through the custom provider path. Do not add a built in provider unless you want first class UX for th

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. The mental model
  2. Choose the implementation path first
  3. Path A — OpenAI-compatible provider
  4. Path B — Native provider
  5. File checklist
  6. Required for every built-in provider
  7. Additional for native / non-OpenAI providers
  8. Fast path: Simple API-key providers
  9. Full path: OAuth and complex providers
  10. Step 1: Pick one canonical provider id
  11. Step 2: Add auth metadata in hermes_cli/auth.py
  12. Step 3: Add model catalog and aliases in hermes_cli/models.py
  13. Step 4: Resolve runtime data in hermes_cli/runtime_provider.py
  14. Step 5: Wire the CLI in hermes_cli/main.py

Section map

The mental model

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

Choose the implementation path first

Maps choose the implementation path first to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Path A — OpenAI-compatible provider

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

Path B — Native provider

Maps path b — native provider to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

File checklist

Maps file checklist to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Required for every built-in provider

Maps required for every built-in provider to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Additional for native / non-OpenAI providers

Maps additional for native / non-openai providers to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Fast path: Simple API-key providers

Maps fast path: simple api-key providers 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: The mental model, Choose the implementation path first, Path A — OpenAI-compatible provider, Path B — Native provider, File checklist. Read those source anchors before changing installs, credentials, automation, or runtime configuration.
  • Useful search signals for this doc: adding, providers, already, openai, compatible. 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 adding providers before applying exact upstream commands.

Verify firstThe mental model

Open the source anchor for The mental model 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 The mental model; 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 Choose the implementation path first 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

Credentials

Treat every token, OAuth grant, secret manager entry, and API key as production-sensitive. Verify least privilege and revocation before reuse.

External messages

Keep human review before sending public posts, customer messages, trading instructions, or team notifications.

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