Skip to main content
xbot
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. xbot
Edit page

xbot

xbot is a self-hosted AI agent framework. Deploy it once on your own server, then talk to it through Feishu, QQ, the terminal, or a web browser — it uses tools to get real work done.

xbot CLI streaming output

Quick Start

 

Installation

Why xbot?

Most AI coding agents live in a single terminal. xbot is different: one agent, every channel. Configure it once on your server, and your whole team reaches the same agent through the tools they already use.

xbotCodex / Claude Code / OpenCode
Multi-channelFeishu · QQ · Web · CLITerminal only
Team shared LLMAdmin configures once, everyone usesEach user brings their own key
Self-hostedYour data never leaves your server✅ (terminal)
Full-featured TUIMouse, themes, command palette, sessions✅
Feishu integrationDocs, Bitable, Drive, cards❌
SubAgents + Group ChatDelegate, parallelize, debateSubAgents only
Plugin ecosystemTools, hooks, widgets, channel pluginsLimited
Important
The most common use case: Deploy Server mode → connect a Feishu app → your whole team @-mentions the bot in group chats. No one configures their own API key.

Core Features

  • 🧠 Multi-turn conversations + tool calling — Shell, file I/O, web search, scheduled tasks, sub-agent delegation
  • 📱 Multi-channel access — one agent, many entry points
  • 🔑 Team-shared LLM subscriptions — admin configures once, everyone uses; switch between subscriptions anytime
  • 🖱️ Full-featured TUI — mouse interaction, command palette (Ctrl+K), multi-session sidebar, theming
  • 🏠 Fully self-hosted — your data stays on your server
  • 🧩 Extensible — Skills, SubAgents, MCP protocol, Plugin system
  • 🤖 AI-Native configuration — the agent can adjust its own settings and UI via the config and tui_control tools

Which channel should I use?

ChannelBest forHighlights
CLIDevelopers, power usersFull TUI, streaming, tool calls, mouse support
FeishuTeam collaboration@mention in group chats, interactive cards
QQ / NapCatIndividuals, small groupsChat via QQ windows
WebAnyone with a browserWeb chat, registration/login, invite-only mode

Quick Start

# Linux / macOS
curl -fsSL https://raw.githubusercontent.com/ai-pivot/xbot/master/scripts/install.sh | bash

# Windows (PowerShell)
irm https://raw.githubusercontent.com/ai-pivot/xbot/master/scripts/install.ps1 | iex

After installation, run xbot-cli. The first run launches a Setup wizard that guides you through API key configuration.

See the Getting Started guide or Installation guide for details.

Architecture

┌──────────┐     ┌──────────────┐     ┌────────────┐     ┌──────────┐
│  Feishu  │────▶│  Dispatcher  │────▶│  Backend    │────▶│   LLM    │
│  QQ      │◀────│  (channel/)  │◀────│  (RPC)      │◀────│ (llm/)   │
│  Web     │     └──────────────┘     │             │     └──────────┘
│  CLI     │                          │  Transport  │
└──────────┘                          │  (local/    │────▶ Tools
                                      │   remote)   │      (tools/)
                                      │             │
                                      │  Agent Loop │────▶ Memory
                                      │  (agent/)   │      (memory/)
                                      └────────────┘

Core design: Backend is a pure RPC client interface (zero business logic), Transport is the execution layer (localTransport calls the Agent directly, remoteTransport forwards over WebSocket).

Read the full Architecture overview.

Community