How mugen0815/hermes-streamdeck works
Hermes Streamdeck is a Stream Deck remote control for an existing Hermes API server, not an agent runtime. A key press resolves a configured prompt, starts a run, tracks its live state, and presents the outcome; Stop and Steer keys act on selected runs. The plugin also tests connectivity, manages an optional SSH tunnel, provides a local approval page, and saves run results. The graph combines shown source references with documented workflows; several action, tracker, and UI implementations were not excerpted, so their links rely on README statements rather than inspected calls.
Main entry points: app.ts Application coordinator · client.ts Hermes API client · manager.ts Run manager · start-run.ts Start Run action
Components 26
Stream Deck controls
- Plugin registration
src/plugin.ts - Start Run action
src/actions/start-run.ts - Stop Run action
src/actions/stop-run.ts - Steer Run action
src/actions/steer-run.ts - Tunnel action
src/actions/tunnel.ts
Run coordination
- Application coordinator
src/app.ts - Run manager
src/runs/manager.ts - Run tracker
src/runs/tracker.ts - Run state model
src/runs/state.ts
Hermes integration
- Hermes API client
src/hermes/client.ts - SSE parser
src/hermes/sse.ts - API error mapping
src/hermes/errors.ts - API data types
src/hermes/types.ts
Connectivity and tunnel
- Connection monitor
src/connection.ts - Connection test
src/connection-test.ts - SSH tunnel controller
src/tunnel/tunnel.ts
User interaction and results
- Prompt templates
src/prompt/template.ts - Desktop interaction
src/system/desktop.ts - Key status rendering
src/ui/render.ts - Approval web server
src/approval/server.ts - Approval page
src/approval/page.ts - Run result storage
src/results/store.ts - Property inspector
io.github.mugen0815.hermes-streamdeck.sdPlugin/ui
Other components
- Stream Deck user
- Hermes API server
- SSH tunnel host
Connections 48
- Stream Deck user → Start Run action: presses key
README.md - Stream Deck user → Stop Run action: presses key
README.md - Stream Deck user → Steer Run action: sends guidance
README.md - Stream Deck user → Tunnel action: toggles tunnel
README.md - Plugin registration → Application coordinator: initializes
src/plugin.ts - Plugin registration → Start Run action: registers
src/plugin.ts - Plugin registration → Stop Run action: registers
src/plugin.ts - Plugin registration → Steer Run action: registers
src/plugin.ts - Plugin registration → Tunnel action: registers
src/plugin.ts - Start Run action → Application coordinator: uses services
src/actions/start-run.ts - Start Run action → Prompt templates: resolves template
src/actions/start-run.ts - Start Run action → Desktop interaction: reads input
src/actions/start-run.ts - Start Run action → Key status rendering: renders status
src/actions/start-run.ts - Start Run action → Run manager: starts run
README.md - Stop Run action → Application coordinator: uses services
src/actions/stop-run.ts - Stop Run action → Run manager: requests stop
README.md - Stop Run action → Key status rendering: renders status
src/actions/stop-run.ts - Steer Run action → Application coordinator: uses services
src/actions/steer-run.ts - Steer Run action → Run manager: sends guidance
README.md - Steer Run action → Prompt templates: resolves text
src/actions/steer-run.ts - Steer Run action → Key status rendering: renders status
src/actions/steer-run.ts - Tunnel action → Application coordinator: uses services
src/actions/tunnel.ts - Tunnel action → SSH tunnel controller: controls tunnel
README.md - Application coordinator → Run manager: constructs
src/app.ts - Application coordinator → Connection monitor: configures
src/app.ts - Application coordinator → Connection test: runs test
src/app.ts - Application coordinator → SSH tunnel controller: monitors changes
src/app.ts - Application coordinator → Approval web server: constructs
src/app.ts - Application coordinator → Run result storage: writes results
src/app.ts - Application coordinator → Desktop interaction: uses desktop
src/app.ts - Run manager → Hermes API client: requests runs
src/runs/manager.ts - Run manager → Run tracker: creates tracker
src/runs/manager.ts - Run manager → Run state model: checks phases
src/runs/manager.ts - Run tracker → Hermes API client: tracks events
src/runs/tracker.ts - Run tracker → Run state model: updates phases
src/runs/tracker.ts - Connection monitor → Hermes API client: checks health
src/connection.ts - Connection test → Hermes API client: tests endpoints
src/connection-test.ts - Connection test → SSH tunnel controller: checks tunnel
src/connection-test.ts - SSH tunnel controller → SSH tunnel host: opens forward
README.md - Hermes API client → Hermes API server: calls API
README.md - Hermes API client → SSE parser: parses events
src/hermes/client.ts - Hermes API client → API error mapping: maps failures
src/hermes/client.ts - Hermes API client → API data types: uses contracts
src/hermes/client.ts - Approval web server → Run manager: handles choices
src/approval/server.ts - Approval web server → Approval page: serves page
src/approval/server.ts - Stream Deck user → Property inspector: configures plugin
README.md - Property inspector → Connection test: requests test
README.md - Application coordinator → Run result storage: saves completed run
src/app.ts