AstrBot README

The project's README from github.com/AstrBotDevs/AstrBot. As one markdown file: README.md.

AstrBot-Logo-Simplified

简体中文 ｜ 繁體中文 ｜ 日本語 ｜ Français ｜ Español ｜ Русский


AstrBotDevs%2FAstrBot | Trendshift Featured｜HelloGitHub

python zread Docker pull

Documentation ｜ Blog ｜ Roadmap ｜ Issue Tracker ｜ Email Support

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.

screenshot_1 5x_postspark_2026-02-27_22-37-45

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.

Quick Start

One-Click Cloud Deployment (RainYun)

For users who want one-click 24-hour-online deployment and do not want to manage servers themselves, we recommend RainYun's one-click cloud deployment service ☁️:

Deploy on RainYun

One-Click Deployment

[!NOTE] Requires uv to be installed. For macOS users: due to macOS security checks, the first run of the astrbot command may take longer (about 10-20s).

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

Update astrbot:

uv tool upgrade astrbot --python 3.12

Docker Deployment

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.

Desktop Application Deployment

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.

Launcher Deployment

For desktop users who also want fast deployment and isolated multi-instance usage, we recommend AstrBot Launcher.

Visit AstrBot Launcher to download and install.

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.

❤️ Sponsors

Welcome to sponsor us via Afdian or contact us.

sponsors

Supported Messaging Platforms

Connect AstrBot to your favorite chat platform.

Platform Maintainer
QQ 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

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
MiraRouter LLM Services (API Gateway, supports all models)
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

❤️ 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

We have 15+ chat groups, please see: Community for details.

Discord Server

Discord_community

❤️ Special Thanks

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

Open Source Friends ❤️

⭐ 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

Star History Chart

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.

私は、高性能ですから!

AstrBot (AstrBotDevs/AstrBot)

Searching Database…

42.1K ·GitHub
AstrBot
这是什么？AstrBot 是一个开源的一体化 AI 智能体聊天机器人平台，可以把大语言模型接入 QQ、Telegram、Discord、Slack、WeChat 等即时通讯应用。你可以在现有的聊天工作流中搭建个人 AI 陪伴助手、客服机器人或企业知识库助手。
这是我要导入的库，还是需要单独运行的服务器？它是一个独立的自托管应用或服务器，自带 WebUI，不是库。你可以通过 uv、Docker 或桌面应用来部署，它会主动连接到你选择的聊天平台和大模型服务商。
我该怎么把它跑起来？推荐的快速方式是使用 uv 一键部署命令。你也可以用 Docker/Docker Compose 进行生产环境部署，使用预构建的 AstrBot-desktop 桌面应用，或使用 AstrBot Launcher 进行隔离的多实例部署。文档中也提供了基于面板的安装方式（BT-Panel、1Panel、CasaOS）。
运行之前需要先安装什么吗？使用命令行方式部署需要先安装 uv；选择容器方式则需要 Docker/Docker Compose。要真正开始对话，你还需要至少一个大模型服务商的凭证（如 OpenAI、Anthropic、Gemini、DeepSeek、Ollama 等），和/或一个聊天平台账号或机器人令牌（bot token）。
安装时有哪些需要留意的坑？在 macOS 上，astrbot 命令首次运行可能明显更慢（约 10-20 秒），这是由 macOS 的安全检查造成的。另外，桌面应用是为个人桌面使用设计的，不适用于服务器部署。
这个项目是为谁设计的？它面向想在即时通讯平台内使用可用于生产环境的对话式 AI 的个人、开发者和团队，从想拥有个人 AI 陪伴助手的爱好者，到希望搭建自动化客服或内部知识库的企业都适用。
它支持哪些聊天平台和大模型？即时通讯集成包括 QQ、Telegram、Discord、Slack、WeChat Work/Official Accounts、Feishu、DingTalk、LINE、Matrix、Rocket.Chat 等。大模型后端包括 OpenAI、Anthropic、Google Gemini、DeepSeek、Ollama、LM Studio，以及多家国内服务商和网关服务商。
我能让所有内容都自托管、离线运行，不依赖第三方大模型云服务吗？可以。除了云端 API，AstrBot 还支持 Ollama、LM Studio 等自托管大模型后端，因此你可以把整套系统跑在本地，而不必把数据发送给第三方大模型服务商。
除了基本的聊天回复，AstrBot 开箱即用还能做什么？它支持多模态大模型对话、智能体/MCP 技能调用、内置知识库、人设设置、自动上下文压缩，以及超过 1000 个可一键安装的插件。
有没有沙箱，可以安全地运行代码或 shell 命令？有。AstrBot 内置了智能体沙箱，可以隔离运行代码和 shell 命令调用，确保执行安全，并支持会话级别的资源复用。
AstrBot 能接入现有的智能体平台，而不是直接调用原始大模型 API 吗？可以。它可以接入 Dify、Alibaba Cloud Bailian 和 Coze 等智能体/LLMOps 平台，既可以替代直接的大模型 API 调用，也可以与之并用。
如果我不想运行服务器，有桌面应用吗？有。AstrBot App（AstrBot-desktop）提供打包好的桌面版本，以聊天界面（ChatUI）为核心，适合个人使用，而不是服务器部署。
What are similar projects?kirara-ai, LangBot, brigade, unsloth, Raven, CowAgent, lobehub, opensquilla
Which topics is it in?qq, agent-sandbox, llama, webui, discord, chat, telegram, gpt, chatgpt, i18n, openai-compatible, knowledge-base
Creator
AstrBotDevs
Size
77.2 MB
Stars
42.1K
Updated
CommitOct 17Releasev4.29.1Oct 17
Age
3y
Commits · 90 Days