Documentation Index
Fetch the complete documentation index at: https://mintlify.com/techjarves/Hermes-USB-Portable/llms.txt
Use this file to discover all available pages before exploring further.
The gateway runs Hermes as a background service that listens for messages from Telegram, WhatsApp, Slack, and other platforms. Use these commands to manage its lifecycle. Once the gateway is running, you can interact with your Hermes agent from any supported messaging app without leaving a terminal open.
Gateway Commands
| Command | Description |
|---|
hermes gateway | Start the gateway in the foreground |
hermes gateway run | Same as hermes gateway |
hermes gateway run --replace | Replace an existing running instance |
hermes gateway restart | Stop and then start the gateway |
hermes gateway stop | Stop the running gateway |
hermes gateway install | Install as a system service (auto-start on boot) |
hermes gateway uninstall | Remove the system service |
hermes gateway status | Check whether the gateway is running |
Examples
# Start the gateway in the foreground
./launch.sh gateway
# Restart after a config change
./launch.sh hermes gateway restart
# Stop the gateway
./launch.sh hermes gateway stop
# Check gateway status
./launch.sh hermes gateway status
# Install as a system service
./launch.sh hermes gateway install
REM Start the gateway in the foreground
launch.bat gateway
REM Restart after a config change
launch.bat hermes gateway restart
REM Stop the gateway
launch.bat hermes gateway stop
REM Install as a system service
launch.bat hermes gateway install
Interactive Launcher
You can also manage the gateway from the Hermes Portable interactive menu without typing any commands:
- Main Menu → [3] Start Gateway — starts the gateway as a background process
- Main Menu → [3] Stop Gateway — shown as
[live] when the gateway is running
- Advanced Options → [4] Restart Gateway — stop and start in one step
Gateway State
The gateway PID is tracked in data/gateway.pid (HERMES_HOME/gateway.pid). The launcher reads this file on startup to display the gateway status in the dashboard.
If the process no longer exists but gateway.pid is still present, the gateway is in a stale lock state. The launcher will show [!] Stopped (stale lock). Start the gateway again — the stale PID file will be cleared automatically.
data/logs/gateway.log. To view the last 20 lines from the Advanced Options menu, choose [2] View Logs.
Telegram Bot Commands
Once the gateway is running and your Telegram bot is configured, send these commands directly to your bot:
| Command | What it does |
|---|
/start | Begin chatting with Hermes |
/stop | Cancel the current task or agent turn |
/sethome | Set this chat as the home channel for cron jobs and notifications |
| Any text | Hermes processes the message as a prompt |
Run hermes setup gateway to configure your Telegram bot token and other messaging platform credentials before starting the gateway.
| Command | Description |
|---|
hermes whatsapp | WhatsApp integration tools |
hermes slack | Slack integration tools |
hermes send | Send a message via the configured gateway |