Install

macOS / Linux (one-click binary):

curl -fsSL https://raw.githubusercontent.com/hrygo/hotplex/main/scripts/install.sh | bash -s -- --latest

Windows (PowerShell 5.1+):

Invoke-WebRequest -Uri https://raw.githubusercontent.com/hrygo/hotplex/main/scripts/install.ps1 -OutFile install.ps1
.\install.ps1 -Latest

From source (requires Go 1.26+, pnpm, Node.js 22+):

git clone https://github.com/hrygo/hotplex.git
cd hotplex
make quickstart

Tip (Claude Code): After cloning, use /hotplex-setup for interactive environment setup and .env configuration.

Docker (Experimental):

cp configs/env.example .env  # edit with your API keys
docker compose up -d

Interactive setup wizard

hotplex onboard

Install as System Service

```bash hotplex service install # user-level (no root) sudo hotplex service install --level system # system-wide hotplex service start hotplex service status hotplex service logs -f

Uninstall

hotplex service uninstall ```

Supports systemd (Linux), launchd (macOS), and Windows SCM.

⚡ Quick Start

AI Agents: Read https://github.com/hrygo/hotplex/blob/main/INSTALL.md and complete the HotPlex installation and configuration

Configure

```bash

Or auto-generate all configs:

hotplex onboard --non-interactive --enable-slack --enable-feishu ```

🛠️ Configuration

[!TIP] See Config Reference for the full list of environment variables and YAML settings.

🔗 SDKs & Libraries

Connect with Go SDK

package main

import (
    "context"
    "fmt"
    client "github.com/hrygo/hotplex/client"
)

func main() {
    c, err := client.New(context.Background(),
        client.URL("ws://localhost:8888/ws"),
        client.WorkerType("claude_code"),
        client.APIKey("<your-api-key>"),
    )
    if err != nil {
        panic(err)
    }
    defer c.Close()

    c.SendInput(context.Background(), "Explain HotPlex architecture")

    for env := range c.Events() {
        if data, ok := env.AsMessageDeltaData(); ok {
            fmt.Print(data.Content)
        }
    }
}

📱 Multi-Platform Delivery & Integration

• 📱 Cross-Platform Delivery — "Write Once, Deploy Anywhere". Bridge agents to Web, Slack (Socket Mode), and Feishu (WebSocket) with zero code changes.
• 💬 Embedded Web Chat — A single binary serves both the API/WebSocket gateway and a premium Next.js-based web chat interface out of the box.
• 🌍 Multi-language SDKs — Go, TypeScript, Python, Java clients ready to use