README.md
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_zh.md">简体中文</a> ｜ <a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_zh-TW.md">繁體中文</a> ｜ <a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_ja.md">日本語</a> ｜ <a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_fr.md">Français</a> ｜ <a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_ru.md">Русский</a>
<div> <a href="https://trendshift.io/repositories/12875" target="_blank"></a> <a href="https://hellogithub.com/repository/AstrBotDevs/AstrBot" target="_blank"></a> </div> <div><a href="https://zread.ai/AstrBotDevs/AstrBot" target="_blank"></a> <a href="https://hub.docker.com/r/soulter/astrbot"></a>
</div><a href="https://astrbot.app/">Documentation</a> ｜ <a href="https://blog.astrbot.app/">Blog</a> ｜ <a href="https://astrbot.featurebase.app/roadmap">Roadmap</a> ｜ <a href="https://github.com/AstrBotDevs/AstrBot/issues">Issue Tracker</a> ｜ <a href="mailto:[email protected]">Email Support</a>
</div>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.
For users who want to quickly experience AstrBot, are familiar with command-line usage, and can install a uv environment on their own, we recommend the uv one-click deployment method ⚡️:
uv tool install astrbot --python 3.12
astrbot init # Only execute this command for the first time to initialize the environment
astrbot run
Requires uv to be installed. AstrBot requires Python 3.12 or later. The
--python 3.12option ensures thatuvcreates the tool environment with Python 3.12.
[!NOTE] For macOS users: due to macOS security checks, the first run of the
astrbotcommand may take longer (about 10-20s).
Update astrbot:
uv tool upgrade astrbot --python 3.12
[!WARNING] AstrBot deployed via
uvdoes not support upgrading through the WebUI. To update, please run the command above from the command line.
For users familiar with containers and looking for a more stable, production-ready deployment method, we recommend deploying AstrBot with Docker / Docker Compose.
Please refer to the official documentation: Deploy AstrBot with Docker.
For users who want one-click deployment and do not want to manage servers themselves, we recommend RainYun's one-click cloud deployment service ☁️:
For users who want to use AstrBot on desktop and mainly use ChatUI, we recommend AstrBot App.
Visit AstrBot-desktop to download and install; this method is designed for desktop usage and is not recommended for server scenarios.
For desktop users who also want fast deployment and isolated multi-instance usage, we recommend AstrBot Launcher.
Visit AstrBot Launcher to download and install.
Replit deployment is maintained by the community and is suitable for online demos and lightweight trials.
AUR deployment targets Arch Linux users who prefer installing AstrBot through the system package workflow.
Run the command below to install astrbot-git, then start AstrBot in your local environment.
yay -S astrbot-git
More deployment methods
If you need panel-based management or deeper customization, see BT-Panel Deployment for BT Panel app-store setup, 1Panel Deployment for 1Panel app-market deployment, CasaOS Deployment for NAS/home-server visual deployment, and Manual Deployment for fully custom source-based installation with uv.
Connect AstrBot to your favorite chat platform.
| Platform | Maintainer |
|---|---|
| Official | |
| OneBot v11 protocol implementation | Official |
| Telegram | Official |
| Wecom & Wecom AI Bot | Official |
| WeChat Official Accounts | Official |
| Feishu (Lark) | Official |
| DingTalk | Official |
| Slack | Official |
| Discord | Official |
| LINE | Official |
| Satori | Official |
| KOOK | Official |
| Misskey | Official |
| Mattermost | Official |
| WhatsApp (Coming Soon) | Official |
| Matrix | Community |
| Rocket.Chat | Community |
| VoceChat | Community |
| 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 |
| AIHubMix | LLM Services (API Gateway, supports all models) |
| 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 |
| Xiaomi MiMo Omni | 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 |
| Xiaomi MiMo TTS | Text-to-Speech Services |
| Volcano Engine TTS | Text-to-Speech Services |
Issues and Pull Requests are always welcome! Feel free to submit your changes to this project :)
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.
AstrBot uses ruff for code formatting and linting.
git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install
Group 12: 916228568 (New)
Group 9: 1076659624 (Full)
Group 10: 1078079676 (Full)
Group 11: 704659519 (Full)
Group 1: 322154837 (Full)
Group 3: 630166526 (Full)
Group 4: 1077826412 (Full)
Group 5: 822130018 (Full)
Group 6: 753075035 (Full)
Group 7: 743746109 (Full)
Group 8: 1030353265 (Full)
Developer Group(Chit-chat): 975206796
Developer Group(Formal): 1039761811
<a href="https://discord.gg/hAVk6tgV36"></a>
Special thanks to all Contributors and plugin developers for their contributions to AstrBot ❤️
<a href="https://github.com/AstrBotDevs/AstrBot/graphs/contributors"> </a>Additionally, the birth of this project would not have been possible without the help of the following open-source projects:
<div align="center"> </div> <div align="center">[!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.
私は、高性能ですから!
</div>