plugin.yaml 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. name: irc-platform
  2. label: IRC
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. IRC gateway adapter for Hermes Agent.
  7. Connects to an IRC server and relays messages between an IRC channel
  8. (or DMs) and the Hermes agent. No external dependencies — uses
  9. Python's stdlib asyncio for the IRC protocol.
  10. author: Nous Research
  11. # ``requires_env`` entries are surfaced in ``hermes config`` UI via the
  12. # platform-plugin env var injector in ``hermes_cli/config.py``.
  13. requires_env:
  14. - name: IRC_SERVER
  15. description: "IRC server hostname (e.g. irc.libera.chat)"
  16. prompt: "IRC server"
  17. password: false
  18. - name: IRC_CHANNEL
  19. description: "Channel to join (e.g. #hermes — comma-separate for multiple)"
  20. prompt: "IRC channel"
  21. password: false
  22. - name: IRC_NICKNAME
  23. description: "Bot nickname on IRC (default: hermes-bot)"
  24. prompt: "Bot nickname"
  25. password: false
  26. optional_env:
  27. - name: IRC_PORT
  28. description: "IRC server port (default: 6697 with TLS, 6667 without)"
  29. prompt: "IRC port"
  30. password: false
  31. - name: IRC_USE_TLS
  32. description: "Use TLS for the IRC connection (1/true/yes to enable, default: true on port 6697)"
  33. prompt: "Use TLS? (true/false)"
  34. password: false
  35. - name: IRC_SERVER_PASSWORD
  36. description: "Server password for the IRC PASS command (optional)"
  37. prompt: "Server password (optional)"
  38. password: true
  39. - name: IRC_NICKSERV_PASSWORD
  40. description: "NickServ password for automatic IDENTIFY on connect (optional)"
  41. prompt: "NickServ password (optional)"
  42. password: true
  43. - name: IRC_ALLOWED_USERS
  44. description: "Comma-separated IRC nicks allowed to talk to the bot"
  45. prompt: "Allowed nicks (comma-separated)"
  46. password: false
  47. - name: IRC_ALLOW_ALL_USERS
  48. description: "Allow anyone in the channel to talk to the bot (dev only)"
  49. prompt: "Allow all users? (true/false)"
  50. password: false
  51. - name: IRC_HOME_CHANNEL
  52. description: "Channel for cron / notification delivery (defaults to IRC_CHANNEL)"
  53. prompt: "Home channel (or empty)"
  54. password: false