Quick Start
Hello!
MaiBot (Mai) is an LLM-powered chatbot framework. Through adapters, it connects to QQ, Telegram, email, iMessage, and other platforms. Like a person, it can chat, remember, learn, be curious, act cheeky, surprise you with what it says, and become your digital pet.
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.
A willingness to ask people and AI for help and think things through.
Mai 101
From zero to chatting takes just four steps.
Install MaiBot
Install MaiBot and its WebUI with uv on Windows, Linux, or macOS.
OneKey, source deployment, and Docker are also available.
Open the WebUI
After startup, open http://localhost:8001 in your browser. The login password usually appears in the startup window.
Configure a Model
Follow the setup guide to enter your API provider's base URL and key, then choose the models to use.
View model config →Connect a Chat Platform
For QQ, the most common example, use an adapter to connect to a QQ Official Bot or SnowLuma to receive messages.
Connect to QQ →Lesson Two
Once it's running, explore the sections below to shape MaiBot into what you want.
I'm a Developer
Want to write plugins or adapters for MaiBot, or integrate it with your own program?
- Integration Overview — six integration routes, organized by audience and prerequisites
- Plugin Development Guide — write plugins to extend MaiBot's behavior
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.