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)

chat
Searching Database…

42K ·GitHub
AstrBot
What is this?AstrBot is an open-source all-in-one AI agent chatbot platform that connects LLMs to messaging apps like QQ, Telegram, Discord, Slack, WeChat and more, so you can build a personal AI companion, customer service bot, or enterprise knowledge-base assistant inside your existing chat workflows.
Is this a library I import, or a standalone server I run?It is a standalone self-hosted application/server with its own WebUI, not a library — you deploy it (via uv, Docker, or a desktop app) and it connects out to your chosen messaging platforms and LLM providers.
How do I get it running?The recommended quick path is the uv one-click deployment command, but you can also deploy with Docker/Docker Compose for production, use the prebuilt AstrBot-desktop app, or use the AstrBot Launcher for isolated multi-instance setups; panel-based installs (BT-Panel, 1Panel, CasaOS) are also documented.
Do I need anything installed before running it?You need uv installed for the CLI deployment method, or Docker/Docker Compose for the containerized route; to actually chat you also need credentials for at least one LLM provider (OpenAI, Anthropic, Gemini, DeepSeek, Ollama, etc.) and/or a messaging platform account/bot token.
Any install pitfalls I should know about?On macOS, the first run of the astrbot command can take noticeably longer (about 10-20 seconds) due to macOS security checks, and the desktop app is meant for personal desktop use rather than server deployments.
Who is this built for?It targets individuals, developers, and teams who want production-ready conversational AI inside IM platforms — from hobbyists wanting a personal AI companion to businesses building automated customer service or internal knowledge bases.
Which chat platforms and LLMs does it support?Messaging integrations include QQ, Telegram, Discord, Slack, WeChat Work/Official Accounts, Feishu, DingTalk, LINE, Matrix, Rocket.Chat and more; LLM backends include OpenAI, Anthropic, Google Gemini, DeepSeek, Ollama, LM Studio and several Chinese and gateway providers.
Can I keep everything self-hosted and offline from third-party LLM clouds?Yes — AstrBot supports self-hosted LLM backends like Ollama and LM Studio in addition to cloud APIs, so you can run the whole stack without sending data to a third-party LLM provider.
What can AstrBot do out of the box besides basic chat replies?It supports multimodal LLM conversations, agent/MCP skill calls, a built-in knowledge base, persona settings, automatic context compression, and over 1000 one-click-installable plugins.
Is there a sandbox for running code or shell commands safely?Yes, AstrBot includes an Agent Sandbox for isolated, safe execution of code and shell calls with session-level resource reuse.
Can AstrBot connect to existing agent platforms instead of raw LLM APIs?Yes, it can integrate with agent/LLMOps platforms like Dify, Alibaba Cloud Bailian, and Coze instead of (or alongside) direct LLM API calls.
Is there a desktop app if I don't want to run a server?Yes, AstrBot App (AstrBot-desktop) provides a packaged desktop experience focused on the ChatUI, intended for personal use rather than server deployments.
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.4 MB
Stars
42K
Updated
CommitOct 16Releasev4.29.0Oct 14
Age
3y
Commits · 90 Days