Grix/aibot protocol platform adapter plugin for Hermes Agent
Project description
grix-hermes
grix-hermes is a standard Hermes platform plugin that connects a Hermes gateway
to Grix through the aibot/Grix Agent API protocol.
What this plugin provides
- A Hermes messaging platform plugin named
grix-hermes - Tools for Grix message, group, auth, and agent operations
- Plugin-scoped skills for profile bootstrap and group operations
Requirements
You need a Grix API Agent and these three credentials:
GRIX_ENDPOINT- WebSocket endpointGRIX_AGENT_ID- agent IDGRIX_API_KEY- API key
You can create an API Agent from grix.dhf.pub in the
AI section.
Choose the target Hermes home
Install and configure the plugin in the same Hermes home that will run the gateway.
Common cases:
- Global Hermes home:
~/.hermes - Profile Hermes home:
~/.hermes/profiles/<profile-name>
If you use a profile-specific gateway, set HERMES_HOME to that profile before
installing or restarting anything. Installing the plugin only into the global
~/.hermes does not make it available inside another profile's Hermes home.
Example:
export HERMES_HOME=/Users/you/.hermes/profiles/grix-online
Standard installation
This is the recommended path.
Install from a Git URL or repository reference:
hermes plugins install <git-url-or-owner/repo> --enable
Install from a local checkout:
hermes plugins install file:///absolute/path/to/grix-hermes --enable
Notes:
--enableupdates the target Hermes config to enablegrix-hermes- The plugin is installed into
<HERMES_HOME>/plugins/grix-hermes - When
HERMES_HOMEis unset, Hermes uses the default global home
PyPI package
You can also install the Python package:
pip install grix-hermes
This installs the Python package only. It does not, by itself, install and
enable the plugin inside a Hermes home. For normal Hermes usage, prefer
hermes plugins install.
Configure credentials
Write the Grix credentials into the target Hermes home's .env file:
- Global home:
~/.hermes/.env - Profile home:
~/.hermes/profiles/<profile-name>/.env
Example:
cat >> "$HERMES_HOME/.env" <<'EOF'
GRIX_ENDPOINT=wss://your-grix-endpoint
GRIX_AGENT_ID=your-agent-id
GRIX_API_KEY=your-api-key
EOF
Optional access controls:
GRIX_ALLOW_ALL_USERS=trueGATEWAY_ALLOW_ALL_USERS=trueGRIX_ALLOWED_USERS=*
Use the access model that matches your environment and policy.
Gateway service setup
After plugin install or Hermes path changes, refresh the gateway service definition for the target Hermes home:
hermes gateway install --force
hermes gateway restart
Why this matters:
- Hermes may run the gateway through a background service such as
launchd - If that service still points to an old Hermes install path, the gateway can fail even when the plugin and credentials are correct
Validate the installation
Check service status:
hermes gateway status
Check recent logs:
tail -n 50 "$HERMES_HOME/logs/gateway.log"
Successful startup should show lines like:
Connecting to grix...grix connectedGateway running with 1 platform(s)
You can also confirm that the plugin is installed under:
<HERMES_HOME>/plugins/grix-hermes
and enabled in:
<HERMES_HOME>/config.yaml
Common problems
Plugin installed globally but not visible in a profile
Symptom:
- Hermes starts, but the profile does not discover
grix-hermes
Cause:
- The plugin was installed into
~/.hermes, but the gateway runs from~/.hermes/profiles/<profile-name>
Fix:
- Set
HERMES_HOMEto the target profile - Re-run
hermes plugins install ... --enable
Gateway service points to an old Hermes path
Symptom:
hermes gateway statusshows the service is loaded- The gateway never becomes healthy
- macOS service metadata or logs refer to a path that no longer exists
Fix:
hermes gateway install --force
hermes gateway restart
Grix authentication failed
Symptom in gateway.log:
grix auth failed: code=10001 msg=auth failed
Cause:
- The current
GRIX_ENDPOINT,GRIX_AGENT_ID, andGRIX_API_KEYdo not match a valid Grix API Agent
Fix:
- Re-check the three
GRIX_*values - Rotate or recreate the API Agent if needed
Gateway says no platforms are enabled
Symptom:
- Logs mention that no messaging platforms are enabled
Fix:
- Make sure
grix-hermesis present in<HERMES_HOME>/config.yaml - Re-run the plugin install with
--enable
Provided tools
| Tool | Description |
|---|---|
grix_invoke |
WS-based operations: send/delete messages, query contacts/sessions, manage groups, and admin agents |
grix_auth |
HTTP auth: send email code, register, login, and create or rotate agent API keys |
grix_card |
Generate Grix deep-link cards for conversations, profiles, and install status |
grix_egg |
Agent bootstrap flow: detect -> install -> create -> bind -> soul -> gateway -> accept |
Plugin skills
After installation, Hermes can load these namespaced skills:
grix-hermes:group-ops- group creation, member management, mute controls, and speaking permissionsgrix-hermes:agent-bootstrap- install, bind, enable, and verify a Grix-backed Hermes profile
Recommended install checklist
- Choose the exact Hermes home or profile that will run the gateway.
- Install the plugin with
hermes plugins install ... --enable. - Write
GRIX_ENDPOINT,GRIX_AGENT_ID, andGRIX_API_KEYinto that target Hermes home's.env. - Run
hermes gateway install --force. - Run
hermes gateway restart. - Verify
hermes gateway statusandgateway.loguntil you seegrix connected.
License
MIT
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file grix_hermes-1.0.5.tar.gz.
File metadata
- Download URL: grix_hermes-1.0.5.tar.gz
- Upload date:
- Size: 57.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bffdd0f2cf6df774e3612e69f16f067dafd5581f1c13890ec70022153dd7bc9f
|
|
| MD5 |
8dcb697601a4aa75d3325461152bc273
|
|
| BLAKE2b-256 |
d1a63a444aee71d2233b2844a144014928ebb35e08c10a79d946a88e7d479fd4
|
File details
Details for the file grix_hermes-1.0.5-py3-none-any.whl.
File metadata
- Download URL: grix_hermes-1.0.5-py3-none-any.whl
- Upload date:
- Size: 61.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1418bd968020119cc5eb03fa03434f0ca77e3634ce15595cb8c423f5515ece3a
|
|
| MD5 |
a6023f4f2b95d990232139ca61ad3078
|
|
| BLAKE2b-256 |
ab154287693a569a208ec1f0e42ce89e7b9915d77578c965eec247b1425c255c
|