20 lines
980 B
Markdown
20 lines
980 B
Markdown
# Root README redirects to the docs; kept short so the repo landing page
|
|
# links straight to the important files.
|
|
|
|
# Pheby — Hermes Platform Adapter/Plugin
|
|
|
|
Private Hermes Agent platform plugin serving the Pheby WebSocket/HTTPS
|
|
protocol for a native Android client.
|
|
|
|
- **Start here:** [docs/README.md](docs/README.md) — architecture, install, Caddy, security, limitations
|
|
- **Protocol spec:** [docs/PROTOCOL.md](docs/PROTOCOL.md) — every message type with JSON examples (Kotlin client reference)
|
|
- **Original product spec:** [docs/spec-source/](docs/spec-source/)
|
|
|
|
Install: copy `plugin/pheby/` into `~/.hermes/plugins/`, set `PHEBY_SECRET`
|
|
in `~/.hermes/.env`, enable it in config.yaml, and set
|
|
`display.platforms.pheby.tool_progress: off` so Hermes's generic text progress
|
|
does not duplicate the adapter's structured tool-event pill. Restart the gateway. See
|
|
[docs/README.md](docs/README.md).
|
|
|
|
Tests: `.venv/bin/python -m pytest tests/ -o addopts= -q --asyncio-mode=auto`
|