Genesis Docs

Genesis documentation

Self-hosted gateway docs for AI agents.

Install Genesis, connect chat channels, run the Gateway, and operate the agent surface from one GitHub Pages site.

Get started Browse all docs GitHub
Genesis npm install -g @pixelzx/genesis@latest genesis onboard --install-daemon genesis dashboard

Start here

Common paths

Guide Getting started Get Genesis installed and run your first chat in minutes. Guide Onboarding (CLI) CLI onboarding: guided setup for gateway, workspace, channels, and skills Guide Install Install Genesis — installer script, npm/pnpm/bun, from source, Docker, and more Guide Chat channels Messaging platforms Genesis can connect to Guide Control UI Browser-based control UI for the Gateway (chat, nodes, config) Guide Configuration Configuration overview: common tasks, quick setup, and links to the full reference

Directory

Docs by area

Get started Genesis is a multi-channel gateway for AI agents that runs on any OS. Install Install Genesis — installer script, npm/pnpm/bun, from source, Docker, and more Channels Messaging platforms Genesis can connect to Agents WebSocket gateway architecture, components, and client flows Tools & Plugins Genesis tools and plugins overview: what the agent can do and how to extend it Models Model providers (LLMs) supported by Genesis Platforms Platform support overview (Gateway + companion apps) Gateway & Ops Runbook for the Gateway service, lifecycle, and operations Reference Genesis CLI index: command list, global flags, and links to per-command pages Help Help hub: common fixes, install sanity, and where to look when something breaks

Genesis 🦞

Genesis

"EXFOLIATE! EXFOLIATE!" — A space lobster, probably

Any OS gateway for AI agents across Discord, Google Chat, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more.
Send a message, get an agent response from your pocket. Run one Gateway across built-in channels, bundled channel plugins, WebChat, and mobile nodes.

What is Genesis?

Genesis is a self-hosted gateway that connects your favorite chat apps and channel surfaces — built-in channels plus bundled or external channel plugins such as Discord, Google Chat, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, 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 built-in channels plus bundled or external channel plugins 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 24 (recommended), or Node 22 LTS (22.14+) for compatibility, 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

  • Multi-channel gateway Discord, iMessage, Signal, Slack, Telegram, WhatsApp, WebChat, and more with a single Gateway process.

  • Plugin channels Bundled plugins add Matrix, Nostr, Twitch, Zalo, and more in normal current releases.

  • Multi-agent routing Isolated sessions per agent, workspace, or sender.

  • Media support Send and receive images, audio, and documents.

  • Web Control UI Browser dashboard for chat, config, sessions, and nodes.

  • Mobile nodes Pair iOS and Android nodes for Canvas, camera, and voice-enabled workflows.

Quick start

Install Genesis

```bash
npm install -g @pixelzx/genesis@latest
```

Onboard and install the service

```bash
genesis onboard --install-daemon
```

Chat

Open the Control UI in your browser and send a message:

```bash
genesis dashboard
```

Or connect a channel ([Telegram](/channels/telegram) is fastest) and chat from your phone.

Need the full install and dev setup? See Getting Started.

Dashboard

Open the browser Control UI after the Gateway starts.

Genesis

Configuration (optional)

Config lives at ~/.genesis/genesis.json.

  • If you do nothing, Genesis 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: ["@genesis"] } },
}

Start here

  • Docs hubs All docs and guides, organized by use case.

  • Configuration Core Gateway settings, tokens, and provider config.

  • Remote access SSH and tailnet access patterns.

  • Channels Channel-specific setup for Feishu, Microsoft Teams, WhatsApp, Telegram, Discord, and more.

  • Nodes iOS and Android nodes with pairing, Canvas, camera, and device actions.

  • Help Common fixes and troubleshooting entry point.

Learn more