📦 Installation Guide
This guide will help you deploy the MaiBot chat robot. We recommend using uv as the Python package manager, which offers faster package installation and better dependency management. The traditional pip method is also available.
Installation and Running
Prerequisites
- Python - Version 3.10 or higher
- Git - (Optional) For easier MaiBot updates
- uv - (Optional) Python package manager
- Memory and Disk Space: Please reserve at least 2GB of memory and 2GB of disk space
Download
You can obtain MaiBot in two ways:
Method 1: Download from Releases (Recommended for beginners)
Visit the GitHub Releases page, download the latest version source code archive, and extract it to use.
Method 2: Clone with Git
git clone https://github.com/MaiM-with-u/MaiBot.gitDomestic Mirror Acceleration
If cloning is slow, you can use a mirror site for acceleration:
git clone https://gh-proxy.com/https://github.com/MaiM-with-u/MaiBot.gitCreate Virtual Environment
# uv
uv venv
# pip
python -m venv venvActivate Virtual Environment
.\venv\Scripts\activateTIP
When using the uv method, you don't need to manually activate the virtual environment; the uv run command handles it automatically.
Install Dependencies
# uv
uv pip install -r requirements.txt
# pip
pip install -r requirements.txtRun
# uv
uv run python bot.py
# pip
python bot.pyConfiguration
MaiBot supports configuration through WebUI:
- After starting the program, open
http://localhost:8001in your browser (default port) - Complete bot configuration, model configuration, and adapter configuration through WebUI, for detailed tutorial see WebUI Configuration Guide.
- For QQ integration, go to Adapters Documentation.
TIP
For manual configuration, refer to the Configuration Guide
Background Running (Linux)
# Install screen (if not installed)
sudo apt install screen
# Start
screen -S maibot
uv run python bot.py
# Press Ctrl+a, then d to exit screen, program runs in backgroundCommon Issues
Having issues? Please refer to the FAQ or join the MaiBot Community for help.