You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
39
+
AstrBot is an open-source, all-in-one Agentic personal and group chat assistant that can be deployed on dozens of mainstream instant messaging platforms such as QQ, Telegram, WeCom, Lark, DingTalk, Slack, and more. 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, smart customer service, automated assistant, or enterprise knowledge base, AstrBot enables you to quickly build AI applications within the workflow of your instant messaging platforms.
3. 🤖 Supports integration with Agent platforms like Dify, Aliyun Bailian, Coze, etc.
48
-
4. 🌐 Multi-platform support: QQ, WeCom, Lark, DingTalk, WeChat Official Account, Telegram, Slack, and [more](#supported-messaging-platforms).
49
-
5. 📦 Plugin Extension: 1000+ plugins available for one-click installation.
50
-
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.
46
+
2. ✨ Large Language Model (LLM) dialogue, Multimodal, Agent, MCP, Skills, Knowledge Base, Persona settings, automatic dialogue compression.
47
+
3. 🤖 Supports integration with agent platforms such as Dify, Alibaba Bailian, Coze, etc.
48
+
4. 🌐 Multi-platform support: QQ, WeCom, Lark, DingTalk, WeChat Official Account, Telegram, Slack, and [more](#supported-message-platforms).
49
+
5. 📦 Plugin extension: 1000+ plugins available for one-click installation.
50
+
6. 🛡️ [Agent Sandbox](https://docs.astrbot.app/use/astrbot-agent-sandbox.html): Isolated environment for safely executing any code, calling Shell commands, and reusing session-level resources.
51
51
7. 💻 WebUI support.
52
-
8. 🌈 Web ChatUI support: ChatUI features built-in proxy sandbox, web search, etc.
52
+
8. 🌈 Web ChatUI support: Built-in proxy sandbox, web search, etc. within ChatUI.
53
53
9. 🌐 Internationalization (i18n) support.
54
54
55
55
<br>
@@ -73,18 +73,21 @@ AstrBot is an open-source, one-stop Agentic personal and group chat assistant. I
73
73
74
74
### One-Click Deployment
75
75
76
-
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 ⚡️.
76
+
For users who want to experience AstrBot quickly, are familiar with the command line, and can install the `uv` environment themselves, we recommend using `uv`for one-click deployment ⚡️.
77
77
78
78
```bash
79
79
uv tool install astrbot
80
-
astrbot init # Run this command only for the first time to initialize the environment
81
-
astrbot run
80
+
astrbot init # Execute this command only for the first time to initialize the environment
81
+
astrbot run # astrbot run --backend-only starts only the backend service
82
+
83
+
# Install development version (more fixes and new features, but less stable; suitable for developers)
> 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).
90
+
> For macOS users: Due to macOS security checks, the first execution of the `astrbot` command may take a longer time (about 10-20 seconds).
88
91
89
92
Update `astrbot`:
90
93
@@ -94,7 +97,7 @@ uv tool upgrade astrbot
94
97
95
98
### Docker Deployment
96
99
97
-
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.
100
+
For users familiar with containers who prefer a more stable deployment suitable for production environments, we recommend using Docker / Docker Compose to deploy AstrBot.
98
101
99
102
Please refer to the official documentation [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html).
100
103
@@ -106,37 +109,37 @@ For users who want to deploy AstrBot with one click and do not want to manage se
106
109
107
110
### Desktop Client Deployment
108
111
109
-
For users who wish to use AstrBot on the desktop and primarily use ChatUI as the entry point, we recommend using the AstrBot App.
112
+
For users who wish to use AstrBot on the desktop with ChatUI as the main interface, we recommend using the AstrBot App.
110
113
111
114
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.
112
115
113
116
### Launcher Deployment
114
117
115
-
Also for desktop use, for users who want to quickly deploy and achieve environment isolation for multiple instances, we recommend AstrBot Launcher.
118
+
Also for desktop, users who want quick deployment and isolated environments for multiple instances can use the AstrBot Launcher.
116
119
117
120
Go to [AstrBot Launcher](https://github.com/Raven95676/astrbot-launcher) to download and install.
118
121
119
122
### Deploy on Replit
120
123
121
-
The Replit deployment is maintained by the community and is suitable for online demonstrations and lightweight trial scenarios.
124
+
Replit deployment is maintained by the community, suitable for online demos and lightweight trials.
122
125
123
126
[](https://repl.it/github/AstrBotDevs/AstrBot)
124
127
125
128
### AUR
126
129
127
-
The AUR method is intended for Arch Linux users who wish to install AstrBot via the system package manager.
130
+
The AUR method is for Arch Linux users who wish to install AstrBot via the system package manager.
128
131
129
-
Run the following command in the terminal to install the `astrbot-git` package. Once installed, you can start using it.
132
+
Execute the following command in the terminal to install the `astrbot-git` package. You can start using it after installation completes.
130
133
131
134
```bash
132
135
yay -S astrbot-git
133
136
```
134
137
135
138
**More Deployment Methods**
136
139
137
-
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`).
140
+
If you need panel-based or highly customized deployment, you can refer to [BT Panel](https://astrbot.app/deploy/astrbot/btpanel.html) (BT Panel App Store), [1Panel](https://astrbot.app/deploy/astrbot/1panel.html) (1Panel App Store), [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`).
138
141
139
-
## Supported Messaging Platforms
142
+
## Supported Message Platforms
140
143
141
144
Connect AstrBot to your favorite chat platforms.
142
145
@@ -173,15 +176,15 @@ Connect AstrBot to your favorite chat platforms.
173
176
| Ollama (Local) | LLM |
174
177
| LM Studio (Local) | LLM |
175
178
|[AIHubMix](https://aihubmix.com/?aff=4bfH)| LLM (API Gateway, supports all models) |
176
-
|[Uyun AI](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74)| LLM (API Gateway, supports all models) |
179
+
|[Compshare](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74)| LLM (API Gateway, supports all models) |
177
180
|[SiliconFlow](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot)| LLM (API Gateway, supports all models) |
178
181
|[PPIO](https://ppio.com/user/register?invited_by=AIOONE)| LLM (API Gateway, supports all models) |
179
182
|[302.AI](https://share.302.ai/rr1M3l)| LLM (API Gateway, supports all models)|
180
183
|[TokenPony](https://www.tokenpony.cn/3YPyf)| LLM (API Gateway, supports all models)|
181
184
| ModelScope | LLM |
182
185
| OneAPI | LLM |
183
186
| Dify | LLMOps Platform |
184
-
|Aliyun Bailian | LLMOps Platform |
187
+
|Alibaba Bailian | LLMOps Platform |
185
188
| Coze | LLMOps Platform |
186
189
| OpenAI Whisper | Speech-to-Text |
187
190
| SenseVoice | Speech-to-Text |
@@ -191,19 +194,23 @@ Connect AstrBot to your favorite chat platforms.
191
194
| GPT-Sovits | Text-to-Speech |
192
195
| FishAudio | Text-to-Speech |
193
196
| Edge TTS | Text-to-Speech |
194
-
|Aliyun Bailian TTS | Text-to-Speech |
197
+
|Alibaba Bailian TTS | Text-to-Speech |
195
198
| Azure TTS | Text-to-Speech |
196
199
| Minimax TTS | Text-to-Speech |
197
-
|Volcengine TTS | Text-to-Speech |
200
+
|Volcano Engine TTS | Text-to-Speech |
198
201
199
202
## ❤️ Contribution
200
203
201
-
Issues and Pull Requests are welcome! Just submit your changes to this project :)
204
+
Welcome any Issues/Pull Requests! Just submit your changes to this project :)
202
205
203
206
### How to Contribute
204
207
205
-
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.
206
-
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.
208
+
You can contribute by viewing issues or helping to review PRs (Pull Requests). Any issues or PRs are welcome to promote community contribution. Of course, these are just suggestions; you can contribute in any way. For new feature additions, please discuss via Issue first.
209
+
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.
210
+
To reduce conflicts, we suggest:
211
+
1. Create your working branch based on the `dev` branch, avoid working directly on the `main` branch.
212
+
2. When submitting a PR, select the `dev` branch as the target.
213
+
3. Regularly sync the `dev` branch to your local environment; use `git pull` frequently.
207
214
208
215
### Development Environment
209
216
@@ -215,13 +222,17 @@ git switch dev # Switch to dev branch
215
222
pip install pre-commit # or uv tool install pre-commit
216
223
pre-commit install
217
224
```
218
-
It is recommended to use `uv` for local installation and testing:
225
+
226
+
We recommend using `uv` for local installation and testing:
227
+
219
228
```bash
220
229
uv tool install -e . --force
221
230
astrbot init
222
231
astrbot run
223
232
```
224
-
Frontend debugging:
233
+
234
+
Frontend Debugging:
235
+
225
236
```bash
226
237
astrbot run --backend-only
227
238
cd dashboard
@@ -239,7 +250,7 @@ bun dev
239
250
- Group 6: 753075035
240
251
- Group 7: 743746109
241
252
- Group 8: 1030353265
242
-
- Developer Group (Casual Chat): 975206796
253
+
- Developer Group (Casual): 975206796
243
254
- Developer Group (Official): 1039761811
244
255
245
256
### Discord Channel
@@ -248,30 +259,30 @@ bun dev
248
259
249
260
## ❤️ Special Thanks
250
261
251
-
Special thanks to all Contributors and Plugin Developers for their contributions to AstrBot ❤️
262
+
Special thanks to all Contributors and plugin developers for their contributions to AstrBot ❤️
-[LangBot](https://github.com/langbot-app/LangBot) - Excellent multi-platform AI ChatBot
268
-
-[ChatLuna](https://github.com/ChatLunaLab/chatluna) - Excellent multi-platform AI ChatBot Koishi plugin
269
-
-[Operit AI](https://github.com/AAswordman/Operit) - Excellent AI intelligent assistant Android APP
278
+
-[LangBot](https://github.com/langbot-app/LangBot) - Excellent Multi-platform AI ChatBot
279
+
-[ChatLuna](https://github.com/ChatLunaLab/chatluna) - Excellent Multi-platform AI ChatBot Koishi Plugin
280
+
-[Operit AI](https://github.com/AAswordman/Operit) - Excellent AI Assistant Android APP
270
281
271
282
## ⭐ Star History
272
283
273
284
> [!TIP]
274
-
> 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
285
+
> If this project helps your life/work, or you are concerned about the future development of this project, please Star the project. This is our motivation to maintain this open-source project <3
0 commit comments