Buzz
Buzz
Start with meaning, then move to detail.
This lesson explains Buzz as part of using Hermes through messaging channels. You will learn what it does, when it matters, and the smallest safe test that proves it works.
If you are new, do not memorize names. Focus on three questions: what problem does this solve, what access does it need, and how can you verify the result?
For practice, inspect the first example, identify its effects, run it on test data, and compare the result with the source claim.
For advanced readers, inspect Prerequisites, Configure Hermes, Option A — config.yaml, then verify failure modes and version compatibility.
Prepare the channel account and understand allowlists and secret storage.
A clear outcome before you read.
- Understand Buzz without assumed prior knowledge.
- Separate the source description from what still needs testing in your environment.
- Read the first command and identify its inputs and outputs before copying it.
Short definitions before the details.
- Gateway
- The process that connects Hermes to channels such as Telegram or Discord and routes messages.
What does the source say, and in what order?
- 01Prerequisites
Start here to understand the core idea or structure.
- 02Configure Hermes
Read this after the foundation, then connect it to the previous step.
- 03Option A — config.yaml
Read this after the foundation, then connect it to the previous step.
- 04Option B — environment variables
Read this after the foundation, then connect it to the previous step.
- 05Recommended default settings
Read this after the foundation, then connect it to the previous step.
- 06Mentions, channels, and DMs
Read this after the foundation, then connect it to the previous step.
- 07Access control
Read this after the foundation, then connect it to the previous step.
- 08Run the gateway
Read this after the foundation, then connect it to the previous step.
- 09Notes and limitations
Finish here to verify the result and special cases.
Copy only after you understand the effect.
gateway:
platforms:
buzz:
enabled: true
extra:
relay_url: https://mycommunity.communities.buzz.xyz
channels: # channel UUIDs to watch (empty = all joined)
- ccc2bc1a-7a82-5a8f-8c4e-57a070cbe7cd
home_channel: ccc2bc1a-7a82-5a8f-8c4e-57a070cbe7cd
poll_interval: 4 # seconds between inbound poll sweeps
cli_path: "" # buzz binary (default: PATH, then ~/bin/buzz)
credentials_file: "" # JSON file with the nsec (BUZZ_PRIVATE_KEY fallback)
allowed_users: [] # emptyBUZZ_PRIVATE_KEY=nsec1...display:
platforms:
buzz:
interim_assistant_messages: false # suppress intermediate tool results, reasoning comments, and progress updates — only the final response reaches the channel
tool_progress: off # suppress tool progress bubbles (e.g., "Running terminal command...", "Reading file...")
gateway:
platforms:
buzz:
enabled: true
extra:
relay_url: https://mycommunity.communities.buzz.xyz
channels: # channel UUIDs to watch (empty = all joined)
- ccc2bc1a-7a82-5a8f-8c4e-57a070cbe7cd
Read the first command and identify its inputs and outputs before copying it.
Match every command to your installed Hermes version, review the files and accounts it can reach, and use non-sensitive data for the first test. If this explanation differs from the source, the official source wins.