plugin.yaml 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. name: bluebubbles-platform
  2. label: BlueBubbles (iMessage)
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. BlueBubbles (Apple iMessage) gateway adapter for Hermes Agent.
  7. Talks to a local BlueBubbles macOS server: outbound sends over its REST API,
  8. inbound messages via a registered webhook listener. Supports media
  9. attachments, typing indicators, read receipts and tapbacks (Private API
  10. helper), group wake-word gating, and home-channel cron delivery.
  11. author: NousResearch
  12. requires_env:
  13. - name: BLUEBUBBLES_SERVER_URL
  14. description: "BlueBubbles server URL (e.g. http://192.168.1.10:1234)"
  15. prompt: "BlueBubbles server URL"
  16. password: false
  17. - name: BLUEBUBBLES_PASSWORD
  18. description: "BlueBubbles server password (BlueBubbles Server → Settings → API)"
  19. prompt: "BlueBubbles server password"
  20. password: true
  21. optional_env:
  22. - name: BLUEBUBBLES_ALLOWED_USERS
  23. description: "Comma-separated iMessage addresses (phone/email) allowed to talk to the bot"
  24. prompt: "Allowed iMessage addresses (comma-separated)"
  25. password: false
  26. - name: BLUEBUBBLES_ALLOW_ALL_USERS
  27. description: "Allow any iMessage sender to trigger the bot (dev only)"
  28. prompt: "Allow all users? (true/false)"
  29. password: false
  30. - name: BLUEBUBBLES_HOME_CHANNEL
  31. description: "Default iMessage address / chat GUID for cron / notification delivery"
  32. prompt: "Home channel address"
  33. password: false
  34. - name: BLUEBUBBLES_HOME_CHANNEL_NAME
  35. description: "Display name for the home channel"
  36. prompt: "Home channel name"
  37. password: false
  38. - name: BLUEBUBBLES_WEBHOOK_HOST
  39. description: "Webhook listener bind host (default 127.0.0.1)"
  40. prompt: "Webhook host"
  41. password: false
  42. - name: BLUEBUBBLES_WEBHOOK_PORT
  43. description: "Webhook listener port (default 8645)"
  44. prompt: "Webhook port"
  45. password: false
  46. - name: BLUEBUBBLES_WEBHOOK_PATH
  47. description: "Webhook listener path (default /bluebubbles-webhook)"
  48. prompt: "Webhook path"
  49. password: false
  50. - name: BLUEBUBBLES_SEND_READ_RECEIPTS
  51. description: "Auto-mark inbound messages read (default true; needs the Private API helper)"
  52. prompt: "Send read receipts? (true/false)"
  53. password: false
  54. - name: BLUEBUBBLES_REQUIRE_MENTION
  55. description: "Require a wake word in group chats (default false)"
  56. prompt: "Require mention in groups? (true/false)"
  57. password: false
  58. - name: BLUEBUBBLES_MENTION_PATTERNS
  59. description: "Group wake-word regexes (JSON list or comma/newline-separated); default Hermes wake words"
  60. prompt: "Mention patterns"
  61. password: false