docs: add Programmatic Integration overview (closes #360)#26757
Merged
Conversation
Document the three protocols already available for driving hermes-agent from external programs — ACP, the TUI gateway JSON-RPC, and the OpenAI-compatible API server — with a 'which one should I use' guide and a Pi-style RPC command mapping table. Sidebar entry under Developer Guide -> Architecture.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the three protocols already available for driving hermes-agent from external programs, so users stop reaching for a hypothetical
--mode rpc.Issue #360 asked for a Pi-style stdio JSON RPC mode. We already ship three programmatic surfaces — ACP, the TUI gateway JSON-RPC, and the OpenAI-compatible API server — that cover every command in Pi's spec. This page makes them findable side-by-side and maps each Pi RPC command to its Hermes equivalent.
Changes
website/docs/developer-guide/programmatic-integration.md— new page: protocol comparison table, Pi command mapping, model-hot-swap notes, "which one should I use" guidewebsite/sidebars.ts— link the new page under Developer Guide -> Architecture (next to the existing ACP / gateway internals pages)Validation
npx docusaurus buildclean (only a pre-existing unrelated broken-anchor warning on a translated page)Closes #360.