Installing and Enabling hermes-paperclip-adapter
Follow these steps to integrate the hermes-paperclip-adapter with your Hermes Agent.
1. Install the adapter
The adapter is available on PyPI or can be installed directly from source. Run one of the following in your terminal:
-
Option A – Install from PyPI (recommended)
Bash
pip install hermes-paperclip-adapter -
Option B – Install from source (for latest dev version)
Bash
git clone https://github.com/hermes-agent/hermes-paperclip-adapter.git cd hermes-paperclip-adapter pip install -e . # Use -e for editable install
Tip: If you use a virtualenv or conda environment for Hermes, ensure it is activated before running the install command so the package is installed in the correct location.
2. Enable the adapter in Hermes config
Hermes loads adapters via its configuration file (typically ~/.hermes/config.yaml).
-
Edit the config:
Bash
hermes config edit -
Add or update the
adaptersblock:YAML
adapters: paperclip: enabled: true # Optional: tweak any adapter-specific settings here # max_size_kb: 1024 -
Save and exit the editor.
3. Verify the adapter is loaded
Verify the installation by listing the currently loaded adapters:
Bash
hermes adapters list
You should see paperclip in the output with a status of enabled.
4. Use the adapter’s actions
Once enabled, the adapter registers its actions with the Hermes registry. Invoke them using standard command syntax:
Bash
hermes run paperclip.copy --text "Hello from Hermes!"
hermes run paperclip.paste
(Check the adapter’s README or run hermes actions list | grep paperclip to see all available action names.)
5. Troubleshooting Checklist
| Symptom | Likely Cause | Fix |
|---|---|---|
ModuleNotFoundError |
Package not installed or installed in wrong env | Re-run pip install in the active Hermes environment. |
Adapter not in adapters list |
Mis-typed config key or missing enabled: true |
Double-check your config.yaml indentation and keys. |
| Permission denied / clipboard errors | Missing system-level access | Ensure you are in a graphical session; install dependencies like xclip, wl-clipboard, or pbcopy/pbpaste. |
| Adapter loads but does nothing | Missing extra configuration | Check the adapter’s README for required environment variables or config fields. |
6. Keep it up-to-date
To upgrade the adapter later:
-
If installed via PyPI:
Bash
pip install --upgrade hermes-paperclip-adapter -
If installed from source:
Bash
git pull && pip install -e .
After updating, restart Hermes or run hermes config reload to apply the changes.
That’s it! The hermes-paperclip-adapter is now ready for use. If you hit any snags, feel free to share the error message for further debugging. Happy clipping! ![]()