Metadata-Version: 2.4
Name: helloagent-hermes-plugin
Version: 0.1.2
Summary: HelloAgent platform plugin for Hermes Agent
Author: HelloAgent
License-Expression: MIT
Project-URL: Homepage, https://github.com/helloagentai/helloagent-hermes-plugin
Project-URL: Repository, https://github.com/helloagentai/helloagent-hermes-plugin.git
Project-URL: Issues, https://github.com/helloagentai/helloagent-hermes-plugin/issues
Keywords: helloagent,hermes-agent,agent,messaging,plugin
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications :: Chat
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: helloagentai>=0.1.1
Provides-Extra: test
Requires-Dist: pytest>=8; extra == "test"
Requires-Dist: pytest-asyncio>=0.24; extra == "test"
Requires-Dist: pytest-cov>=5; extra == "test"
Requires-Dist: pyyaml>=6; extra == "test"
Requires-Dist: ruff>=0.8; extra == "test"
Dynamic: license-file

# helloagent-hermes-plugin

Connects a Hermes gateway to the HelloAgent relay so users can DM the agent
from the HelloAgent mobile or web app.

## Setup

1. Install the plugin into the same Python environment as Hermes:

   ```bash
   pip install helloagent-hermes-plugin
   ```

2. Create an agent token at:

   ```text
   https://app.helloagent.cc/app/agents/new
   ```

3. Connect Hermes to HelloAgent:

   ```bash
   helloagent-hermes connect
   ```

   The command prompts for your `ha_*` token, an optional allowlist, and
   whether to restart the gateway. It installs the user-plugin link, enables
   `helloagent` in Hermes, writes the token into Hermes' environment, and
   saves a local credential record.

For non-interactive setup, pass the settings as flags:

```bash
helloagent-hermes connect --token ha_... --allow-from your_handle --restart-gateway
```

## Manual setup

If you prefer to configure Hermes by hand:

1. Register the plugin with Hermes' current user-plugin directory:

   ```bash
   helloagent-hermes install
   hermes plugins enable helloagent
   ```

2. Create an agent token at:

   ```text
   https://app.helloagent.cc/app/agents/new
   ```

3. Save the token for Hermes:

   ```bash
   export HELLOAGENT_TOKEN=ha_...
   hermes gateway restart
   ```

## Environment variables

| Variable | Purpose |
|---|---|
| `HELLOAGENT_TOKEN` | `ha_*` agent token. |
| `HELLOAGENT_ALLOWED_USERS` | Comma-separated handles allowed by the adapter prefilter. |
| `HELLOAGENT_ALLOW_ALL_USERS` | Allow any HelloAgent sender. |
| `HELLOAGENT_DEBUG` | Enable verbose SDK logging when set to `1`. |

## Notes

Plugin v1 sends complete replies through Hermes' normal `adapter.send()` path.
Token-by-token streaming is intentionally left for a later SDK/Hermes stream
transport integration.

The package also exposes a `hermes_agent.plugins` entry point named
`helloagent`. The directory install step is included because Hermes 0.13's
plugin management CLI lists/enables directory plugins, while entry-point
plugins are only discovered by the runtime loader.
