hermes-ryzome-plugin

Ryzome canvas and document tools for the Hermes Agent. Lets an AI agent externalize its working context (plans, research, reasoning) as interactive canvases. Users can inspect, edit, and hand the corrected graph back to the agent.

Requirements

• Python 3.10+
• Node.js (the wheel bundles a compiled Node runner; node must be on PATH)
• A Ryzome API key — get one here

Install

pip install hermes-ryzome-plugin
hermes plugins enable ryzome
export RYZOME_API_KEY=<api-key>

Hermes disables discovered plugins by default, including pip-installed ones, so hermes plugins enable ryzome is required after pip install.

For git installs via Hermes:

hermes plugins install 0xPlaygrounds/hermes-ryzome-plugin --enable

During hermes plugins install, Hermes prompts for RYZOME_API_KEY from plugin.yaml and saves it to ~/.hermes/.env automatically.

The wheel bundles the Node runner (ryzome_hermes_plugin/_runner.js) — no separate npm install is required.

Configure

Hermes-native auth for general plugins is requires_env in plugin.yaml, which hermes plugins install prompts for and saves to ~/.hermes/.env.

You can also configure the plugin manually with either:

export RYZOME_API_KEY=<api-key>

or a config file at ~/.hermes/ryzome.json:

{
  "apiKey": "rz_...",
  "apiUrl": "https://api.ryzome.ai",
  "appUrl": "https://ryzome.ai"
}

Config fields

Environment variables RYZOME_API_KEY, RYZOME_OPENCLAW_API_KEY, or PLUGIN_USER_CONFIG_API_KEY also work and take precedence over the config file.

Tools

Slash Commands

This matches how Hermes general plugins work in practice today: tools + optional slash commands, with auth handled through requires_env and ~/.hermes/.env.

There is no separate plugin auth step inside hermes setup for general plugins.

Environment Variables

Troubleshooting

Ryzome API key not configured

Tools register unconditionally but throw this error on call if no key is set. The standard fix is to reinstall or enable the plugin through Hermes so requires_env prompts for RYZOME_API_KEY, or set RYZOME_API_KEY manually.

Could not find a Ryzome Hermes runner

The wheel ships with a bundled Node runner. If this error appears, verify:

• node is on PATH
• The wheel installed cleanly (the file ryzome_hermes_plugin/_runner.js exists inside the installed package)
• Or set RYZOME_HERMES_RUNNER to a command that runs the runner

401 or 403 errors

• Verify the API key is valid and has canvas route access
• If using a non-production API, confirm apiUrl matches that environment

License

MIT