Files
bot/docs/index.md
zooqueen adb8e1f802 feat: merge upstream improvements via rebrand bridge
Squash merge of 1,462 upstream commits with openclaw→hanzo-bot
naming transforms applied. Conflicts resolved favoring our main
branch to preserve existing customizations.

Key upstream additions:
- iOS Security Stack (concurrency locks, runtime guards, TTS fallback)
- Discord CDN hostname allowlisting for SSRF protection
- Discord mention handling improvements
- Various bug fixes and stability improvements
2026-03-03 09:38:30 -08:00

5.9 KiB

summary, read_when, title
summary read_when title
Hanzo Bot is a multi-channel gateway for AI agents that runs on any OS.
Introducing Hanzo Bot to newcomers
Hanzo Bot

Hanzo Bot

Hanzo Bot Hanzo Bot

Your AI team, deployed everywhere.

Any OS gateway for AI agents across WhatsApp, Telegram, Discord, iMessage, and more.
Send a message, get an agent response from your pocket. Plugins add Mattermost and more.

Install Hanzo Bot and bring up the Gateway in minutes. Guided setup with `hanzo-bot onboard` and pairing flows. Launch the browser dashboard for chat, config, and sessions.

What is Hanzo Bot?

Hanzo Bot is a self-hosted gateway that connects your favorite chat apps — WhatsApp, Telegram, Discord, iMessage, and more — to AI coding agents like Pi. You run a single Gateway process on your own machine (or a server), and it becomes the bridge between your messaging apps and an always-available AI assistant.

Who is it for? Developers and power users who want a personal AI assistant they can message from anywhere — without giving up control of their data or relying on a hosted service.

What makes it different?

  • Self-hosted: runs on your hardware, your rules
  • Multi-channel: one Gateway serves WhatsApp, Telegram, Discord, and more simultaneously
  • Agent-native: built for coding agents with tool use, sessions, memory, and multi-agent routing
  • Open source: MIT licensed, community-driven

What do you need? Node 22+, an API key from your chosen provider, and 5 minutes. For best quality and security, use the strongest latest-generation model available.

How it works

flowchart LR
  A["Chat apps + plugins"] --> B["Gateway"]
  B --> C["Pi agent"]
  B --> D["CLI"]
  B --> E["Web Control UI"]
  B --> F["macOS app"]
  B --> G["iOS and Android nodes"]

The Gateway is the single source of truth for sessions, routing, and channel connections.

Key capabilities

WhatsApp, Telegram, Discord, and iMessage with a single Gateway process. Add Mattermost and more with extension packages. Isolated sessions per agent, workspace, or sender. Send and receive images, audio, and documents. Browser dashboard for chat, config, sessions, and nodes. Pair iOS and Android nodes for Canvas, camera/screen, and voice-enabled workflows.

Quick start

```bash npm install -g bot@latest ``` ```bash hanzo-bot onboard --install-daemon ``` ```bash hanzo-bot channels login hanzo-bot gateway --port 18789 ```

Need the full install and dev setup? See Quick start.

Dashboard

Open the browser Control UI after the Gateway starts.

Hanzo Bot

Configuration (optional)

Config lives at ~/.hanzo/bot/bot.json.

  • If you do nothing, Hanzo Bot uses the bundled Pi binary in RPC mode with per-sender sessions.
  • If you want to lock it down, start with channels.whatsapp.allowFrom and (for groups) mention rules.

Example:

{
  channels: {
    whatsapp: {
      allowFrom: ["+15555550123"],
      groups: { "*": { requireMention: true } },
    },
  },
  messages: { groupChat: { mentionPatterns: ["@bot"] } },
}

Start here

All docs and guides, organized by use case. Core Gateway settings, tokens, and provider config. SSH and tailnet access patterns. Channel-specific setup for WhatsApp, Telegram, Discord, and more. iOS and Android nodes with pairing, Canvas, camera/screen, and device actions. Common fixes and troubleshooting entry point.

Learn more

Complete channel, routing, and media capabilities. Workspace isolation and per-agent sessions. Tokens, allowlists, and safety controls. Gateway diagnostics and common errors. Project origins, contributors, and license.