mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-06-12 08:51:53 +00:00
573c4e6511
Pin spectrum-ts to exactly 3.0.0 (was ^1.18.0 plus an `npm install spectrum-ts@latest` on every setup) so breaking SDK majors can't take down fresh installs silently; `hermes photon setup` now runs `npm ci`. Upgrade procedure documented in the README. Migrate resolveSpace to the v3 namespace API: `im.space.create(phone)` for DMs and `im.space.get(id)` for everything else — group spaces are now rehydratable from their persisted id after a sidecar restart, which v1 could not do. Markdown: replies go out via the v3 `markdown()` builder (iMessage renders natively; other Spectrum platforms degrade to plain text). `PHOTON_MARKDOWN=false` reverts to the stripped plain-text path. Reactions, behind PHOTON_REACTIONS (default off): lifecycle tapbacks (👀 while processing, 👍/👎 on completion) via new sidecar /react and /unreact endpoints with per-target reaction-handle tracking, and user tapbacks on bot-sent messages routed to the agent as synthetic `reaction:added:<emoji>` events. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
88 lines
4.1 KiB
YAML
88 lines
4.1 KiB
YAML
name: photon-platform
|
|
label: iMessage via Photon
|
|
kind: platform
|
|
version: 0.3.0
|
|
description: >
|
|
Photon Spectrum gateway adapter for Hermes Agent.
|
|
Connects to iMessage (and other Spectrum interfaces) through Photon's
|
|
managed Spectrum platform. Both directions run over the `spectrum-ts`
|
|
SDK's long-lived gRPC stream via a small supervised Node sidecar —
|
|
inbound messages arrive on the SDK's `app.messages` stream (no webhook,
|
|
no public URL, no signing secret), and outbound messages are sent over
|
|
the same sidecar.
|
|
|
|
The plugin ships with a `hermes photon` CLI for the one-time device
|
|
login + project + user setup. Runtime credentials are written to
|
|
``~/.hermes/.env`` (``PHOTON_PROJECT_ID`` = the Spectrum project id,
|
|
``PHOTON_PROJECT_SECRET``) like every other channel, with management
|
|
metadata (device token, dashboard project id) in ``~/.hermes/auth.json``.
|
|
Photon's free shared-line model lets users get started without a paid plan.
|
|
author: NousResearch
|
|
requires_env:
|
|
- name: PHOTON_PROJECT_ID
|
|
description: "Spectrum project id (the project's spectrumProjectId; set by `hermes photon setup`)"
|
|
prompt: "Photon Spectrum project id"
|
|
url: "https://app.photon.codes/"
|
|
password: false
|
|
- name: PHOTON_PROJECT_SECRET
|
|
description: "Project secret paired with the Spectrum project id (set by `hermes photon setup`)"
|
|
prompt: "Photon project secret"
|
|
url: "https://app.photon.codes/"
|
|
password: true
|
|
optional_env:
|
|
- name: PHOTON_SIDECAR_PORT
|
|
description: "Loopback port for the Node sidecar control + inbound channel (default 8789)"
|
|
prompt: "Sidecar control port"
|
|
password: false
|
|
- name: PHOTON_SIDECAR_AUTOSTART
|
|
description: "Spawn the Node sidecar on connect (true/false, default true)"
|
|
prompt: "Auto-start the sidecar?"
|
|
password: false
|
|
- name: PHOTON_NODE_BIN
|
|
description: "Path to the node binary (default: shutil.which('node'))"
|
|
prompt: "Node executable path"
|
|
password: false
|
|
- name: PHOTON_DASHBOARD_HOST
|
|
description: "Photon Dashboard API host (default https://app.photon.codes)"
|
|
prompt: "Dashboard host"
|
|
password: false
|
|
- name: PHOTON_SPECTRUM_HOST
|
|
description: "Photon Spectrum API host (default https://spectrum.photon.codes)"
|
|
prompt: "Spectrum API host"
|
|
password: false
|
|
- name: PHOTON_ALLOWED_USERS
|
|
description: "Comma-separated E.164 phone numbers allowed to talk to the bot"
|
|
prompt: "Allowed users (comma-separated)"
|
|
password: false
|
|
- name: PHOTON_ALLOW_ALL_USERS
|
|
description: "Allow any sender to trigger the bot (dev only — disables allowlist)"
|
|
prompt: "Allow all users? (true/false)"
|
|
password: false
|
|
- name: PHOTON_REQUIRE_MENTION
|
|
description: "Ignore group-chat messages unless they match a mention wake word (true/false, default false)"
|
|
prompt: "Require a mention in group chats?"
|
|
password: false
|
|
- name: PHOTON_MENTION_PATTERNS
|
|
description: "Mention wake-word regexes for group chats (JSON list or comma/newline-separated; defaults to Hermes wake words)"
|
|
prompt: "Group mention patterns"
|
|
password: false
|
|
- name: PHOTON_HOME_CHANNEL
|
|
description: "Default Photon target for cron / notification delivery: Spectrum space id, DM GUID, or bare E.164 phone number"
|
|
prompt: "Home Photon target"
|
|
password: false
|
|
- name: PHOTON_HOME_CHANNEL_NAME
|
|
description: "Human label for the home channel"
|
|
prompt: "Home channel display name"
|
|
password: false
|
|
- name: PHOTON_TELEMETRY
|
|
description: "Enable Spectrum SDK telemetry in the sidecar (true/false, default false; toggle with `hermes photon telemetry on|off`)"
|
|
prompt: "Enable Spectrum telemetry? (true/false)"
|
|
password: false
|
|
- name: PHOTON_MARKDOWN
|
|
description: "Send agent replies as markdown — iMessage renders it natively, other Spectrum platforms degrade to plain text (true/false, default true)"
|
|
prompt: "Render replies as markdown? (true/false)"
|
|
password: false
|
|
- name: PHOTON_REACTIONS
|
|
description: "Tapback 👀/👍/👎 on messages as processing status and route tapbacks on bot messages to the agent (true/false, default false)"
|
|
prompt: "Enable reaction tapbacks? (true/false)"
|
|
password: false
|