Back to Commands
Gateway & Platformshermes pairing

hermes pairing Command — Complete Reference & Examples

Complete reference for hermes pairing: approve or revoke messaging pairing codes, managing which devices and users can connect to Hermes through the gateway.

July 27, 2026

Overview

hermes pairing manages pairing codes for the Hermes messaging gateway. When a new device or user tries to connect through the gateway, a pairing code is generated. This command lists pending and approved requests, authorizes new connections, revokes access, and clears stale pending codes.

Usage

hermes pairing [-h] {list,approve,revoke,clear-pending} ...

Subcommands

list

Show pending and approved users.

hermes pairing list

approve

Approve a pairing request.

hermes pairing approve <code>

revoke

Revoke user access.

hermes pairing revoke <code>

clear-pending

Clear all pending codes.

hermes pairing clear-pending

Examples

# List all pending and approved pairings
hermes pairing list

# Approve a new Telegram pairing request
hermes pairing approve ABCD1234

# Revoke access for a device or user
hermes pairing revoke WXYZ9012

# Clear expired or unwanted pending codes
hermes pairing clear-pending

Tips

  • Pairing codes are generated when a user or device first contacts the gateway.
  • Approve codes promptly — pending codes may expire.
  • Use hermes pairing list regularly to audit active connections.
  • Revoking access takes effect immediately; no gateway restart is required.
  • clear-pending only removes pending codes, not already-approved pairings.

Explore All Commands

Browse the full command reference with search and category filters.

Back to Commands