Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Atbash Hermes Plugin

Atbash guardrail plugin for Hermes Agent using the official Python SDK (atbash-sdk).

The plugin registers a Hermes pre_tool_call hook and asks Atbash for a verdict before a Hermes tool runs. If Atbash returns a blocking decision, the tool call is stopped before execution.

What It Does

  • Intercepts Hermes tool calls through pre_tool_call.
  • Sends the tool name, arguments, command-like payload, session metadata, and inferred action class to Atbash.
  • Blocks tool execution on BLOCK, DENY, REJECT, DISALLOW, or HOLD.
  • Persists learned Hermes tool classifications across sessions.

Install

Install the plugin into the same Python environment that runs Hermes. This prerelease requires Python 3.10 through 3.12, matching atbash-sdk==0.4.3.dev0.

pip install --pre atbash-hermes-plugin==0.4.3.dev0

If Hermes is installed in a virtual environment, use that environment's Python:

/path/to/hermes/venv/bin/python -m pip install --pre atbash-hermes-plugin==0.4.3.dev0

Configure Atbash

The plugin needs an Atbash agent key. Configure either ATBASH_KEY_PATH or ATBASH_AGENT_PRIVKEY.

Recommended:

ATBASH_KEY_PATH=$HOME/.config/atbash/guard-client-key

Alternative:

ATBASH_AGENT_PRIVKEY='{"pubkey":"...","privkey":"..."}'

Where To Set Environment Variables

Hermes commonly loads environment variables from ~/.hermes/.env.

Create or edit that file:

nano ~/.hermes/.env

Add:

ATBASH_KEY_PATH=$HOME/.config/atbash/guard-client-key
ATBASH_ENFORCE_DECISION=true
ATBASH_DEBUG=false
ATBASH_ORG_NAME=your-org-name

Restart Hermes after changing .env.

For a one-off terminal session, you can also export variables before starting Hermes:

export ATBASH_KEY_PATH="$HOME/.config/atbash/guard-client-key"
export ATBASH_ENFORCE_DECISION=true
export ATBASH_DEBUG=false
hermes

Optional Settings

# Override the Atbash API endpoint.
ATBASH_ENDPOINT=https://api.atbash.io

# Set to self-hosted when using your own judge endpoint. Self-hosted judges
# require ATBASH_JUDGE_VERIFY_PUBKEY so the SDK can verify signed responses.
ATBASH_JUDGE_ENDPOINT_POLICY=default
ATBASH_JUDGE_VERIFY_PUBKEY=

# Fail closed when Atbash cannot be reached. Default: true.
ATBASH_ENFORCE_DECISION=true

# Emit verbose plugin logs. Default: false.
ATBASH_DEBUG=false

# Resolve the Atbash organization subscription/network. This lets the SDK
# choose the public or private chain for that org.
ATBASH_ORG_NAME=your-org-name

# Override where learned Hermes tool classifications are saved.
ATBASH_TOOL_MAP_PATH=$HOME/.config/atbash/hermes-tool-map.json

Telemetry

The plugin initializes the Atbash Python SDK OpenTelemetry metrics with source="plugin:hermes", matching the pattern used by the OpenClaw plugin. Telemetry is best-effort and never blocks guard registration or tool execution.

The Python SDK telemetry opt-out is file-based. To disable telemetry, create:

mkdir -p ~/.config/atbash
printf '{"enabled": false}\n' > ~/.config/atbash/telemetry.json

Enable Or Check The Plugin

Hermes should discover installed Python packages that expose the hermes_agent.plugins entry point.

Check whether Hermes sees the plugin:

hermes plugins list | grep atbash

If needed, enable it:

hermes plugins enable atbash-hermes-plugin

Verify It Is Working

Start Hermes and ask it to do something that uses a tool, such as creating a file or opening a website.

In another terminal, watch the Hermes log:

tail -f ~/.hermes/logs/agent.log

With ATBASH_DEBUG=true, you should see lines similar to:

[atbash-hermes-plugin] registered pre_tool_call hook
Atbash pre_tool_call enter tool=...
Atbash verdict tool=... verdict=ALLOW reason=...

If Atbash blocks a tool call, Hermes receives a blocking response before the tool executes.

Docker

When running Hermes in Docker, mount your Hermes data directory and put the Atbash key inside the mounted volume.

Example host layout:

~/.hermes/
  .env
  atbash/
    guard-client-key

Example ~/.hermes/.env for Docker:

ATBASH_KEY_PATH=/opt/data/atbash/guard-client-key
ATBASH_ENFORCE_DECISION=true
ATBASH_DEBUG=false
ATBASH_ORG_NAME=your-org-name

Run Hermes:

docker run --rm -it \
  -v ~/.hermes:/opt/data \
  nousresearch/hermes-agent

You can also pass variables directly:

docker run --rm -it \
  -v ~/.hermes:/opt/data \
  -e ATBASH_KEY_PATH=/opt/data/atbash/guard-client-key \
  -e ATBASH_ENFORCE_DECISION=true \
  -e ATBASH_DEBUG=false \
  -e ATBASH_ORG_NAME=your-org-name \
  nousresearch/hermes-agent

Tool Classification

Hermes tool names can vary by version, installed plugins, and enabled skills. The plugin ships with defaults for common tools and learns unseen tool names at runtime.

Learned mappings are saved to:

~/.config/atbash/hermes-tool-map.json

Set ATBASH_TOOL_MAP_PATH to override the location. The file persists across Hermes sessions.

Verdict Behavior

  • ALLOW: the tool proceeds.
  • HOLD: the tool is blocked with a review message.
  • BLOCK, DENY, REJECT, DISALLOW: the tool is blocked.
  • Atbash API error:
    • ATBASH_ENFORCE_DECISION=true: fail closed and block.
    • ATBASH_ENFORCE_DECISION=false: fail open and allow.

For HOLD, the user-facing block message is:

Action held for operator review. The agent will not be jailed — please approve or reject this request from the Atbash dashboard, then ask the agent to try again.
Reason: <original reason from judge>
Judgment ID: <held judgment id, when provided by the SDK>

After dashboard approval or rejection, the SDK can query held-action status with the judgment ID. The Hermes plugin blocks the original tool call and asks the user to retry after review, rather than automatically re-running the action.

Troubleshooting

If Hermes does not show the plugin:

hermes plugins list | grep atbash
python -m pip show atbash-hermes-plugin

Make sure the package was installed into the same Python environment that runs Hermes.

If Atbash verdicts are not appearing in logs:

ATBASH_DEBUG=true

Then restart Hermes and watch:

tail -f ~/.hermes/logs/agent.log

If the plugin blocks everything with an unavailable-key or authentication error, check:

echo "$ATBASH_KEY_PATH"
test -f "$ATBASH_KEY_PATH" && echo "key file exists"

If using Docker, remember that paths inside the container are different from host paths. Prefer /opt/data/... paths for mounted Hermes data.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atbash_hermes_plugin-0.4.4.dev0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file atbash_hermes_plugin-0.4.4.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for atbash_hermes_plugin-0.4.4.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd0046606fd34138dd30e85f062a678d5563ae29ecba93d5292defe7dd54be7f
MD5 bf5b1881f77a3c980ebf6134f7aab214
BLAKE2b-256 90cb07b48b076f83f40fd715aa1bb3c9f1e8226c670bb2fc5b15687ce0bf997b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page