Quick Start
Welcome to the MaiBot User Manual. MaiBot is an LLM-powered chatbot framework — through adapters it connects to platforms such as QQ, email, and iMessage, and chats, remembers, learns, and uses tools in group conversations like a real person. This manual walks you through installation, configuration, and platform connection from scratch, then helps you master every feature.
System Requirements
A computer with internet access (Windows 10+ / Linux / macOS), at least 2GB of free memory, and an LLM API key. The hardware bar is low — an ordinary home computer is enough.
🚀 Quick Start
From zero to chatting takes just four steps, about 1–2 minutes each. Just follow the cards below.
Install MaiBot
Windows users are recommended to use the one-click package — no command-line tools needed. Double-click to install; it automatically sets up the Python environment and launches a configuration wizard. Linux, macOS, and container options are also available.
View install guide →Open the WebUI
After startup, open http://localhost:8001 in your browser and paste the login token printed in the terminal on first launch. The WebUI is MaiBot's graphical management interface — most configuration happens here.
Configure a Model
In the WebUI's model settings, enter your API provider's base URL and key, then pick the model you want. You need at least one LLM model before MaiBot can speak.
View model config →Connect a Chat Platform
Taking QQ as the most common example: install NapCat and enable its forward WebSocket, then install and enable the "NapCat Adapter" from the plugin store in the WebUI — MaiBot can join your group chats.
Connect to QQ →📖 Going Further
Once it's running, explore the sections below to shape MaiBot into what you want.
💬 Need Help?
- Check the FAQ first — most deployment, connection, and error questions already have answers.
- Join the MaiBot community — the QQ groups offer technical Q&A and friendly help.
- Ask or discuss in GitHub Discussions.