mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-16 01:40:15 +08:00
290 lines
15 KiB
Markdown
290 lines
15 KiB
Markdown
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README.md">English</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"><img src="https://trendshift.io/api/badge/repositories/12875" alt="Soulter%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||
<a href="https://hellogithub.com/repository/AstrBotDevs/AstrBot" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=d127d50cd5e54c5382328acc3bb25483&claim_uid=ZO9by7qCXgSd6Lp&t=2" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||
</div>
|
||
|
||
<br>
|
||
|
||
<div>
|
||
<img src="https://img.shields.io/github/v/release/AstrBotDevs/AstrBot?color=76bad9" href="https://github.com/AstrBotDevs/AstrBot/releases/latest">
|
||
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
|
||
<img src="https://deepwiki.com/badge.svg" href="https://deepwiki.com/AstrBotDevs/AstrBot">
|
||
<a href="https://zread.ai/AstrBotDevs/AstrBot" target="_blank"><img src="https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTk4IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff" alt="zread"/></a>
|
||
<a href="https://hub.docker.com/r/soulter/astrbot"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/soulter/astrbot.svg?color=76bad9"/></a>
|
||
<img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.soulter.top%2Fastrbot%2Fplugin-num&query=%24.result&suffix=%20Plugins&label=Marketplace&cacheSeconds=3600">
|
||
<img src="https://gitcode.com/Soulter/AstrBot/star/badge.svg" href="https://gitcode.com/Soulter/AstrBot">
|
||
</div>
|
||
|
||
<br>
|
||
|
||
<a href="https://astrbot.app/">Home</a> ｜
|
||
<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">Issues</a>
|
||
<a href="mailto:community@astrbot.app">Email</a>
|
||
|
||
</div>
|
||
|
||
AstrBot is an open-source, one-stop Agentic personal and group chat assistant. It can be deployed on dozens of mainstream instant messaging platforms such as QQ, Telegram, WeCom, Lark (Feishu), DingTalk, Slack, etc. It also features a built-in lightweight ChatUI similar to OpenWebUI, creating a reliable and scalable conversational AI infrastructure for individuals, developers, and teams. Whether it's a personal AI companion, intelligent customer service, automated assistant, or enterprise knowledge base, AstrBot enables you to quickly build AI applications within the workflow of your instant messaging platforms.
|
||
|
||
|
||
|
||
## Key Features
|
||
|
||
1. 💯 Free & Open Source.
|
||
2. ✨ AI LLM Chat, Multimodal, Agent, MCP, Skills, Knowledge Base, Persona, Auto-summarization.
|
||
3. 🤖 Supports integration with Agent platforms like Dify, Aliyun Bailian, Coze, etc.
|
||
4. 🌐 Multi-platform support: QQ, WeCom, Lark, DingTalk, WeChat Official Account, Telegram, Slack, and [more](#supported-messaging-platforms).
|
||
5. 📦 Plugin Extension: 1000+ plugins available for one-click installation.
|
||
6. 🛡️ [Agent Sandbox](https://docs.astrbot.app/use/astrbot-agent-sandbox.html): An isolated environment to safely execute code, call Shell, and reuse session-level resources.
|
||
7. 💻 WebUI support.
|
||
8. 🌈 Web ChatUI support: ChatUI features built-in proxy sandbox, web search, etc.
|
||
9. 🌐 Internationalization (i18n) support.
|
||
|
||
<br>
|
||
|
||
<table align="center">
|
||
<tr align="center">
|
||
<th>💙 Roleplay & Companionship</th>
|
||
<th>✨ Proactive Agent</th>
|
||
<th>🚀 General Agentic Capabilities</th>
|
||
<th>🧩 1000+ Community Plugins</th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center"><p align="center"><img width="984" height="1746" alt="99b587c5d35eea09d84f33e6cf6cfd4f" src="https://github.com/user-attachments/assets/89196061-3290-458d-b51f-afa178049f84" /></p></td>
|
||
<td align="center"><p align="center"><img width="976" height="1612" alt="c449acd838c41d0915cc08a3824025b1" src="https://github.com/user-attachments/assets/f75368b4-e022-41dc-a9e0-131c3e73e32e" /></p></td>
|
||
<td align="center"><p align="center"><img width="974" height="1732" alt="image" src="https://github.com/user-attachments/assets/e22a3968-87d7-4708-a7cd-e7f198c7c32e" /></p></td>
|
||
<td align="center"><p align="center"><img width="976" height="1734" alt="image" src="https://github.com/user-attachments/assets/0952b395-6b4a-432a-8a50-c294b7f89750" /></p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
## Quick Start
|
||
|
||
### One-Click Deployment
|
||
|
||
For users who want to quickly experience AstrBot, are familiar with the command line, and can install the `uv` environment themselves, we recommend using the `uv` one-click deployment method ⚡️.
|
||
|
||
```bash
|
||
uv tool install astrbot
|
||
astrbot init # Run this command only for the first time to initialize the environment
|
||
astrbot run
|
||
```
|
||
|
||
> Requires [uv](https://docs.astral.sh/uv/) installation.
|
||
|
||
> [!NOTE]
|
||
> For macOS users: Due to macOS security checks, running the `astrbot` command for the first time may take a long time (about 10-20 seconds).
|
||
|
||
Update `astrbot`:
|
||
|
||
```bash
|
||
uv tool upgrade astrbot
|
||
```
|
||
|
||
### Docker Deployment
|
||
|
||
For users familiar with containers who prefer a more stable deployment method suitable for production environments, we recommend using Docker / Docker Compose to deploy AstrBot.
|
||
|
||
Please refer to the official documentation [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html).
|
||
|
||
### Deploy on RainYun
|
||
|
||
For users who want to deploy AstrBot with one click and do not want to manage servers themselves, we recommend RainYun's one-click cloud deployment service ☁️:
|
||
|
||
[](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0)
|
||
|
||
### Desktop Client Deployment
|
||
|
||
For users who wish to use AstrBot on the desktop and primarily use ChatUI as the entry point, we recommend using the AstrBot App.
|
||
|
||
Go to [AstrBot-desktop](https://github.com/AstrBotDevs/AstrBot-desktop) to download and install; this method is intended for desktop use and is not recommended for server scenarios.
|
||
|
||
### Launcher Deployment
|
||
|
||
Also for desktop use, for users who want to quickly deploy and achieve environment isolation for multiple instances, we recommend AstrBot Launcher.
|
||
|
||
Go to [AstrBot Launcher](https://github.com/Raven95676/astrbot-launcher) to download and install.
|
||
|
||
### Deploy on Replit
|
||
|
||
The Replit deployment is maintained by the community and is suitable for online demonstrations and lightweight trial scenarios.
|
||
|
||
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
||
|
||
### AUR
|
||
|
||
The AUR method is intended for Arch Linux users who wish to install AstrBot via the system package manager.
|
||
|
||
Run the following command in the terminal to install the `astrbot-git` package. Once installed, you can start using it.
|
||
|
||
```bash
|
||
yay -S astrbot-git
|
||
```
|
||
|
||
**More Deployment Methods**
|
||
|
||
If you need a panel-based or highly customized deployment, please refer to [BT Panel](https://astrbot.app/deploy/astrbot/btpanel.html) (BT Panel App Store installation), [1Panel](https://astrbot.app/deploy/astrbot/1panel.html) (1Panel App Store installation), [CasaOS](https://astrbot.app/deploy/astrbot/casaos.html) (NAS / Home Server visual deployment), and [Manual Deployment](https://astrbot.app/deploy/astrbot/cli.html) (Full custom installation based on source code and `uv`).
|
||
|
||
## Supported Messaging Platforms
|
||
|
||
Connect AstrBot to your favorite chat platforms.
|
||
|
||
| Platform | Maintainer |
|
||
|---------|---------------|
|
||
| **QQ** | Official |
|
||
| **OneBot v11** | Official |
|
||
| **Telegram** | Official |
|
||
| **WeCom App & Bot** | Official |
|
||
| **WeChat Customer Service & Official Account** | Official |
|
||
| **Lark (Feishu)** | Official |
|
||
| **DingTalk** | Official |
|
||
| **Slack** | Official |
|
||
| **Discord** | Official |
|
||
| **LINE** | Official |
|
||
| **Satori** | Official |
|
||
| **Misskey** | Official |
|
||
| **Whatsapp (Coming Soon)** | Official |
|
||
| [**Matrix**](https://github.com/stevessr/astrbot_plugin_matrix_adapter) | Community |
|
||
| [**KOOK**](https://github.com/wuyan1003/astrbot_plugin_kook_adapter) | Community |
|
||
| [**VoceChat**](https://github.com/HikariFroya/astrbot_plugin_vocechat) | Community |
|
||
|
||
## Supported Model Providers
|
||
|
||
| Provider | Type |
|
||
|---------|---------------|
|
||
| Custom | Any OpenAI API compatible service |
|
||
| OpenAI | LLM |
|
||
| Anthropic | LLM |
|
||
| Google Gemini | LLM |
|
||
| Moonshot AI | LLM |
|
||
| Zhipu AI | LLM |
|
||
| DeepSeek | LLM |
|
||
| Ollama (Local) | LLM |
|
||
| LM Studio (Local) | LLM |
|
||
| [AIHubMix](https://aihubmix.com/?aff=4bfH) | LLM (API Gateway, supports all models) |
|
||
| [Uyun AI](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74) | LLM (API Gateway, supports all models) |
|
||
| [SiliconFlow](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot) | LLM (API Gateway, supports all models) |
|
||
| [PPIO](https://ppio.com/user/register?invited_by=AIOONE) | LLM (API Gateway, supports all models) |
|
||
| [302.AI](https://share.302.ai/rr1M3l) | LLM (API Gateway, supports all models)|
|
||
| [TokenPony](https://www.tokenpony.cn/3YPyf) | LLM (API Gateway, supports all models)|
|
||
| ModelScope | LLM |
|
||
| OneAPI | LLM |
|
||
| Dify | LLMOps Platform |
|
||
| Aliyun Bailian | LLMOps Platform |
|
||
| Coze | LLMOps Platform |
|
||
| OpenAI Whisper | Speech-to-Text |
|
||
| SenseVoice | Speech-to-Text |
|
||
| OpenAI TTS | Text-to-Speech |
|
||
| Gemini TTS | Text-to-Speech |
|
||
| GPT-Sovits-Inference | Text-to-Speech |
|
||
| GPT-Sovits | Text-to-Speech |
|
||
| FishAudio | Text-to-Speech |
|
||
| Edge TTS | Text-to-Speech |
|
||
| Aliyun Bailian TTS | Text-to-Speech |
|
||
| Azure TTS | Text-to-Speech |
|
||
| Minimax TTS | Text-to-Speech |
|
||
| Volcengine TTS | Text-to-Speech |
|
||
|
||
## ❤️ Contribution
|
||
|
||
Issues and Pull Requests are welcome! Just submit your changes to this project :)
|
||
|
||
### How to Contribute
|
||
|
||
You can contribute by viewing issues or helping to review PRs (Pull Requests). Any issue or PR is welcome to participate in promoting community contributions. Of course, these are just suggestions, and you can contribute in any way. For the addition of new features, please discuss via Issue first.
|
||
It is recommended to merge functional PRs into the `dev` branch, which will be merged into the main branch and released as a new version after testing modifications.
|
||
|
||
### Development Environment
|
||
|
||
AstrBot uses `ruff` for code formatting and checking.
|
||
|
||
```bash
|
||
git clone https://github.com/AstrBotDevs/AstrBot
|
||
git switch dev # Switch to dev branch
|
||
pip install pre-commit # or uv tool install pre-commit
|
||
pre-commit install
|
||
```
|
||
It is recommended to use `uv` for local installation and testing:
|
||
```bash
|
||
uv tool install -e . --force
|
||
astrbot init
|
||
astrbot run
|
||
```
|
||
Frontend debugging:
|
||
```bash
|
||
astrbot run --backend-only
|
||
cd dashboard
|
||
bun install # or pnpm, etc.
|
||
bun dev
|
||
```
|
||
|
||
### QQ Groups
|
||
|
||
- Group 9: 1076659624 (New)
|
||
- Group 10: 1078079676 (New)
|
||
- Group 1: 322154837
|
||
- Group 3: 630166526
|
||
- Group 5: 822130018
|
||
- Group 6: 753075035
|
||
- Group 7: 743746109
|
||
- Group 8: 1030353265
|
||
- Developer Group (Casual Chat): 975206796
|
||
- Developer Group (Official): 1039761811
|
||
|
||
### Discord Channel
|
||
|
||
- [Discord](https://discord.gg/hAVk6tgV36)
|
||
|
||
## ❤️ Special Thanks
|
||
|
||
Special thanks to all Contributors and Plugin Developers for their contributions to AstrBot ❤️
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=AstrBotDevs/AstrBot&max=200&columns=14" />
|
||
</a>
|
||
|
||
In addition, the birth of this project cannot be separated from the help of the following open-source projects:
|
||
|
||
- [NapNeko/NapCatQQ](https://github.com/NapNeko/NapCatQQ) - The great cat framework
|
||
|
||
Open source project friendly links:
|
||
|
||
- [NoneBot2](https://github.com/nonebot/nonebot2) - Excellent Python asynchronous ChatBot framework
|
||
- [Koishi](https://github.com/koishijs/koishi) - Excellent Node.js ChatBot framework
|
||
- [MaiBot](https://github.com/Mai-with-u/MaiBot) - Excellent anthropomorphic AI ChatBot
|
||
- [nekro-agent](https://github.com/KroMiose/nekro-agent) - Excellent Agent ChatBot
|
||
- [LangBot](https://github.com/langbot-app/LangBot) - Excellent multi-platform AI ChatBot
|
||
- [ChatLuna](https://github.com/ChatLunaLab/chatluna) - Excellent multi-platform AI ChatBot Koishi plugin
|
||
- [Operit AI](https://github.com/AAswordman/Operit) - Excellent AI intelligent assistant Android APP
|
||
|
||
## ⭐ Star History
|
||
|
||
> [!TIP]
|
||
> If this project has been helpful to your life/work, or if you are interested in the future development of this project, please give the project a Star. This is our motivation to maintain this open-source project <3
|
||
|
||
<div align="center">
|
||
|
||
[](https://star-history.com/#astrbotdevs/astrbot&Date)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
_Companionship and capability should never be opposites. We hope to create a robot that can both understand emotions, provide companionship, and reliably complete tasks._
|
||
|
||
_私は、高性能ですから!_
|
||
|
||
<img src="https://files.astrbot.app/watashiwa-koseino-desukara.gif" width="100"/>
|
||
|
||
</div> |