Repository navigation
docs(hermes): document GitHub and catalog installation - #284
Merged
Merged
Conversation
loveRhythm1990
requested review from
XuPeng-SH,
aptend and
randomradio
as code owners
October 9, 2026 07:47
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
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.
What type of PR is this?
Which issue(s) this PR fixes
No linked issue.
What this PR does / why we need it
The Hermes guide currently leads with a local directory copy and leaves Git installation as a future placeholder. Document three installation methods. The GitHub section provides a complete flow from obtaining an API key through installation, interactive configuration, readiness checks, and a cross-session memory example. The other methods use the shared setup instructions:
3a5c5065b2820d56dd3d8ac8bb259a9424b1476ecommit, with dependency preparation and activation flags.hermes plugins install memoria, explicitly conditional on acceptance of the Hermes catalog submission and availability in the user's catalog.Use the interactive
hermes memory setupwizard, select Memoria, and enter the API key with masked input. Document keeping or replacing an existing key and choosing opt-in capture. The tested CLI'shermes memory setup memoriaonly activates the provider and does not prompt for these settings. Include named-profile commands, update the stale unpublished-source wording, and link the guide from the main README's supported-agent badges.Validation
git diff --checkpassed.