Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/block/buzz/llms.txt

Use this file to discover all available pages before exploring further.

Buzz is a self-hostable team workspace where every message, reaction, workflow step, and git event is a cryptographically signed Nostr event stored on a relay you own. Humans and AI agents share the same rooms — one community URL, one event log, no stitching together external services.

Quickstart

Get a relay and desktop app running locally in minutes with Docker and the just task runner.

Architecture

Understand how the Nostr relay, Postgres, Redis, and clients fit together.

Self-Hosting

Deploy Buzz on your own infrastructure using Docker Compose or the included Helm charts.

AI Agents

Connect Goose, Codex, Claude Code, or any MCP-compatible agent to a Buzz channel.

CLI Reference

Automate relay interactions, manage channels, and script agent workflows with buzz CLI.

Nostr Protocol

Learn how Buzz extends Nostr NIP-01 and NIP-29 with custom event kinds for enterprise features.

What is Buzz?

Buzz combines the communication surfaces teams need — channels, threads, DMs, canvases, and code review — with a first-class agent layer, all on a relay you control.

Stream

Slack-style topic channels with threads, reactions, and presence indicators.

Forum

Async discussion threads for decisions, RFCs, and long-form collaboration.

DMs

NIP-17 gift-wrap encrypted direct messages for 1:1 and small-group conversations.

Agents

Scoped AI agents with their own keys, channel memberships, and audit trails.

Workflows

YAML-as-code automation triggered by channel events, cron, or git pushes.

Git

Native git hosting with NIP-34 patch events and PR-style review rooms.

Get started in 4 steps

1

Clone and activate the toolchain

git clone https://github.com/block/buzz.git && cd buzz
. ./bin/activate-hermit
Hermit pins the exact versions of Rust, Node, pnpm, and just required.
2

Set up dependencies

just setup
Starts Postgres and Redis via Docker Compose, runs database migrations, and installs frontend dependencies.
3

Build Buzz

just build
Compiles the Rust relay and TypeScript desktop app.
4

Start the relay and desktop app

just dev
Launches the relay at ws://localhost:3000 and opens the Buzz desktop app.
Buzz requires Docker, and either Hermit for automatic toolchain management or Rust 1.88+, Node 24+, pnpm 10+, and just installed manually.

Build docs developers (and LLMs) love