Timmy_Foundation/hermes-agent
15
0
Fork 0
Code Issues 248 Pull Requests 14 Actions 1 Packages Projects Releases Wiki Activity

docs: update AGENTS.md, README.md, and messaging.md to include interactive setup for messaging platforms

Browse Source 
Enhanced documentation to reflect the new interactive setup command for configuring messaging platforms (Telegram, Discord, Slack, WhatsApp). Updated sections in AGENTS.md, README.md, and messaging.md to provide clear instructions on using the 'hermes gateway setup' command, improving user experience and accessibility for platform configuration.
This commit is contained in:
teknium1
2026-03-03 19:00:09 -08:00
parent fa3d7b3d03
commit 1754bdf1e8
3 changed files with 58 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/messaging.md
View File

@@ -4,27 +4,33 @@ Hermes Agent can connect to messaging platforms like Telegram, Discord, and What
## Quick Start
The easiest way to configure messaging is the interactive wizard:
```bash
# 1. Set your bot token(s) in ~/.hermes/.env
echo 'TELEGRAM_BOT_TOKEN="your_telegram_bot_token"' >> ~/.hermes/.env
echo 'DISCORD_BOT_TOKEN="your_discord_bot_token"' >> ~/.hermes/.env
# 2. Test the gateway (foreground)
./scripts/hermes-gateway run
# 3. Install as a system service (runs in background)
./scripts/hermes-gateway install
# 4. Manage the service
./scripts/hermes-gateway start
./scripts/hermes-gateway stop
./scripts/hermes-gateway restart
./scripts/hermes-gateway status
hermes gateway setup # Configure Telegram, Discord, Slack, WhatsApp
```
**Quick test (without service install):**
This walks you through each platform with arrow-key selection, handles tokens, allowlists, and home channels, and offers to start/restart the gateway when done.
**Or configure manually** by editing `~/.hermes/.env`:
```bash
python cli.py --gateway # Runs in foreground, useful for debugging
# Set your bot token(s)
echo 'TELEGRAM_BOT_TOKEN="your_telegram_bot_token"' >> ~/.hermes/.env
echo 'DISCORD_BOT_TOKEN="your_discord_bot_token"' >> ~/.hermes/.env
```
**Then start the gateway:**
```bash
hermes gateway # Run in foreground (useful for debugging)
hermes gateway install # Install as a system service (runs in background)
# Manage the service
hermes gateway start
hermes gateway stop
hermes gateway restart
hermes gateway status
```
## Architecture Overview