Getting Started

Get xbot running in under 5 minutes.

Note

System requirements: Any modern OS (Linux, macOS, Windows). No pre-installed dependencies needed — the installer downloads a static binary.

# 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

The installer downloads the xbot-cli binary, generates a random admin token, writes ~/.xbot/config.json, then runs xbot-cli setup to install the Web UI and every built-in plugin and enable the web channel — in both modes, so the browser works right away.

Note

Behind a firewall (China)? Use the mirror-accelerated installer:

curl -fsSL https://ghfast.top/https://raw.githubusercontent.com/ai-pivot/xbot/master/scripts/install-cn.sh | bash

Tip

Rather not do it yourself? Paste this into your AI agent — it installs and verifies on its own:

Install and start xbot on this machine:
1. curl -fsSL https://raw.githubusercontent.com/ai-pivot/xbot/master/scripts/install.sh | bash
2. xbot-cli setup --check     # exit code 0 means a complete install
3. nohup xbot-cli serve >/tmp/xbot.log 2>&1 &
4. curl -s -o /dev/null -w '%{http_code}' http://127.0.0.1:8082   # must print 200
If anything fails, read https://ai-pivot.github.io/xbot/installation/ (Troubleshooting).

The installer asks you to pick:

Most teams should choose Server mode. Pick Standalone for a quick solo test drive.

Server mode enables the web channel ("web": { "enable": true, "port": 8082 } in ~/.xbot/config.json). Browse to http://localhost:8082 and click Create account — the first registration becomes the operator account.

The empty workspace shows a three-step guide: configure a model, create a session, start chatting.

Run xbot-cli. The first launch opens a Setup wizard:

1. Choose an LLM provider (OpenAI / Anthropic / OpenAI-compatible)
2. Enter your API key
3. Set the API base URL (change this for DeepSeek, Qwen, Ollama, etc.)
4. Pick a model
5. Configure model tiers (Vanguard / Balance / Swift — used for different scenarios)

Re-run the wizard anytime with /setup or Ctrl+K → Setup.

Subscriptions, not a single global key. xbot uses a subscription system. You can create multiple subscriptions (e.g. work Claude, personal DeepSeek) and switch between them per session.

Tip

Using DeepSeek, Qwen, or Ollama? Set provider: "openai" and change the base_url in the Setup wizard. xbot works with any OpenAI-compatible API.

You’re ready. Type a message and press Enter. The agent can call tools, run commands, search the web, and delegate to sub-agents.

You: What files are in this directory?

Agent: *uses Shell tool to run ls*
Agent: The current directory contains...

You: Read the README.md and summarize it

Agent: *uses Read tool*
Agent: This project is about...

You: Create a new file called notes.txt with today's date

Agent: *uses FileCreate tool*
Agent: Done! Created notes.txt with today's date.

You: Search the web for the latest Go release

Agent: *uses WebSearch tool*
Agent: The latest Go release is...

The agent picks the right tool for the job — you just describe what you want.

Type / to see all slash commands. A few essentials: