plugin.yaml 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. name: buzz-platform
  2. label: Buzz
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. Buzz gateway adapter for Hermes Agent.
  7. Connects to a Buzz community relay (Block's open-source human+agent
  8. collaboration platform built on Nostr) and relays messages between
  9. channels/DMs and the Hermes agent. Relay operations shell out to the
  10. buzz CLI binary (JSON in/out); verified inbound media uses Hermes' bundled
  11. HTTP client.
  12. author: Nous Research
  13. # ``requires_env`` entries are surfaced in ``hermes config`` UI via the
  14. # platform-plugin env var injector in ``hermes_cli/config.py``.
  15. requires_env:
  16. - name: BUZZ_RELAY_URL
  17. description: "Base URL of the Buzz community relay (e.g. https://mycommunity.communities.buzz.xyz)"
  18. prompt: "Buzz relay URL"
  19. password: false
  20. - name: BUZZ_PRIVATE_KEY
  21. description: "Nostr private key for the agent's Buzz identity (nsec or hex) — the only Buzz secret"
  22. prompt: "Nostr private key (nsec or hex)"
  23. password: true
  24. optional_env:
  25. - name: BUZZ_TRANSPORT
  26. description: "Inbound transport: auto (WebSocket w/ poll fallback, default), websocket, or poll"
  27. prompt: "Transport (auto/websocket/poll)"
  28. password: false
  29. - name: BUZZ_AUTH_TAG
  30. description: "Optional NIP-OA owner-attestation auth tag JSON for NIP-42 WebSocket auth"
  31. prompt: "NIP-OA auth tag JSON (or empty)"
  32. password: false
  33. - name: BUZZ_CHANNELS
  34. description: "Comma-separated channel UUIDs to watch (default: all joined channels)"
  35. prompt: "Channel UUIDs (comma-separated)"
  36. password: false
  37. - name: BUZZ_HOME_CHANNEL
  38. description: "Channel UUID for cron / notification delivery (defaults to the first watched channel)"
  39. prompt: "Home channel UUID (or empty)"
  40. password: false
  41. - name: BUZZ_ALLOWED_USERS
  42. description: "Comma-separated npubs or hex pubkeys allowed to talk to the agent"
  43. prompt: "Allowed users (comma-separated)"
  44. password: false
  45. - name: BUZZ_ALLOW_ALL_USERS
  46. description: "Allow any community member to talk to the agent (true/false)"
  47. prompt: "Allow all users? (true/false)"
  48. password: false
  49. - name: BUZZ_POLL_INTERVAL
  50. description: "Seconds between inbound poll sweeps (default: 4)"
  51. prompt: "Poll interval seconds"
  52. password: false
  53. - name: BUZZ_CLI_PATH
  54. description: "Path to the buzz CLI binary (default: 'buzz' on PATH, then ~/bin/buzz)"
  55. prompt: "buzz CLI path (or empty)"
  56. password: false
  57. - name: BUZZ_CREDENTIALS_FILE
  58. description: "JSON credentials file holding the nsec (fallback when BUZZ_PRIVATE_KEY is unset)"
  59. prompt: "Credentials file path (or empty)"
  60. password: false
  61. - name: BUZZ_REPLY_IN_THREAD
  62. description: "Thread replies under the triggering message (true/false, default: true); false posts flat to the channel timeline"
  63. prompt: "Reply in thread? (true/false)"
  64. password: false