AstrBot/README.md

中文 ｜ 日本語 ｜ 繁體中文 ｜ Français ｜ Русский

Documentation ｜ Blog ｜ Roadmap ｜ Issue Tracker

AstrBot is an open-source all-in-one Agent chatbot platform that integrates with mainstream instant messaging apps. It provides reliable and scalable conversational AI infrastructure for individuals, developers, and teams. Whether you're building a personal AI companion, intelligent customer service, automation assistant, or enterprise knowledge base, AstrBot enables you to quickly build production-ready AI applications within your IM platform workflows.

Key Features

1. 💯 Free & Open Source.
2. ✨ AI LLM Conversations, Multimodal, Agent, MCP, Skills, Knowledge Base, Persona Settings, Auto Context Compression.
3. 🤖 Supports integration with Dify, Alibaba Cloud Bailian, Coze, and other agent platforms.
4. 🌐 Multi-Platform: QQ, WeChat Work, Feishu, DingTalk, WeChat Official Accounts, Telegram, Slack, and more.
5. 📦 Plugin Extensions with 1000+ plugins available for one-click installation.
6. 🛡️ Agent Sandbox for isolated, safe execution of code, shell calls, and session-level resource reuse.
7. 💻 WebUI Support.
8. 🌈 Web ChatUI Support with built-in agent sandbox and web search.
9. 🌐 Internationalization (i18n) Support.

💙 Role-playing & Emotional Companionship	✨ Proactive Agent	🚀 General Agentic Capabilities	🧩 1000+ Community Plugins

Quick Start

Docker Deployment (Recommended 🥳)

We recommend deploying AstrBot using Docker or Docker Compose.

Please refer to the official documentation: Deploy AstrBot with Docker.

uv Deployment

uv tool install astrbot
astrbot

System Package Manager Installation

Arch Linux

yay -S astrbot-git
# or use paru
paru -S astrbot-git

Desktop Application (Tauri)

Desktop repository: AstrBot-desktop.

Supports multiple system architectures, direct installation, out-of-the-box experience. Ideal for beginners.

AstrBot Launcher

Quick deployment and multi-instance solution. Visit the AstrBot Launcher repository and find the latest release for your system.

BT-Panel Deployment

AstrBot has partnered with BT-Panel and is now available in their marketplace.

Please refer to the official documentation: BT-Panel Deployment.

1Panel Deployment

AstrBot has been officially listed on the 1Panel marketplace.

Please refer to the official documentation: 1Panel Deployment.

Deploy on RainYun

For Chinese users:

AstrBot has been officially listed on RainYun's cloud application platform with one-click deployment.

Deploy on Replit

Community-contributed deployment method.

Windows One-Click Installer

Please refer to the official documentation: Deploy AstrBot with Windows One-Click Installer.

CasaOS Deployment

Community-contributed deployment method.

Please refer to the official documentation: CasaOS Deployment.

Manual Deployment

First, install uv:

pip install uv

Install AstrBot via Git Clone:

git clone https://github.com/AstrBotDevs/AstrBot && cd AstrBot
uv run main.py

Or refer to the official documentation: Deploy AstrBot from Source.

Supported Messaging Platforms

Connect AstrBot to your favorite chat platform.

Platform	Maintainer
QQ	Official
OneBot v11 protocol implementation	Official
Telegram	Official
WeChat Work Application & WeChat Work Intelligent Bot	Official
WeChat Customer Service & WeChat Official Accounts	Official
Feishu (Lark)	Official
DingTalk	Official
Slack	Official
Discord	Official
LINE	Official
Satori	Official
Misskey	Official
WhatsApp (Coming Soon)	Official
Matrix	Community
KOOK	Community
VoceChat	Community

Supported Model Services

Service	Type
OpenAI and Compatible Services	LLM Services
Anthropic	LLM Services
Google Gemini	LLM Services
Moonshot AI	LLM Services
Zhipu AI	LLM Services
DeepSeek	LLM Services
Ollama (Self-hosted)	LLM Services
LM Studio (Self-hosted)	LLM Services
CompShare	LLM Services
302.AI	LLM Services
TokenPony	LLM Services
SiliconFlow	LLM Services
PPIO Cloud	LLM Services
ModelScope	LLM Services
OneAPI	LLM Services
Dify	LLMOps Platforms
Alibaba Cloud Bailian Applications	LLMOps Platforms
Coze	LLMOps Platforms
OpenAI Whisper	Speech-to-Text Services
SenseVoice	Speech-to-Text Services
OpenAI TTS	Text-to-Speech Services
Gemini TTS	Text-to-Speech Services
GPT-Sovits-Inference	Text-to-Speech Services
GPT-Sovits	Text-to-Speech Services
FishAudio	Text-to-Speech Services
Edge TTS	Text-to-Speech Services
Alibaba Cloud Bailian TTS	Text-to-Speech Services
Azure TTS	Text-to-Speech Services
Minimax TTS	Text-to-Speech Services
Volcano Engine TTS	Text-to-Speech Services

❤️ Contributing

Issues and Pull Requests are always welcome! Feel free to submit your changes to this project :)

How to Contribute

You can contribute by reviewing issues or helping with pull request reviews. Any issues or PRs are welcome to encourage community participation. Of course, these are just suggestions—you can contribute in any way you like. For adding new features, please discuss through an Issue first.

Development Environment

AstrBot uses ruff for code formatting and linting.

git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install

🌍 Community

QQ Groups

• Group 1: 322154837
• Group 3: 630166526
• Group 5: 822130018
• Group 6: 753075035
• Group 7: 743746109
• Group 8: 1030353265
• Developer Group: 975206796

Telegram Group

Discord Server

❤️ Special Thanks

Special thanks to all Contributors and plugin developers for their contributions to AstrBot ❤️

Additionally, the birth of this project would not have been possible without the help of the following open-source projects:

• NapNeko/NapCatQQ - The amazing cat framework

⭐ Star History

Tip

If this project has helped you in your life or work, or if you're interested in its future development, please give the project a Star. It's the driving force behind maintaining this open-source project <3

Companionship and capability should never be at odds. What we aim to create is a robot that can understand emotions, provide genuine companionship, and reliably accomplish tasks.

私は、高性能ですから!