Helian Nuits
c5bd074c28
* chore(README): updated with README.md * Update README_fr.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> * Update README_zh-TW.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> --------- Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
304 lines
12 KiB
Markdown
304 lines
12 KiB
Markdown
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_en.md">English</a> ｜
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_ja.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_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%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%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=%E4%B8%AA&label=%E6%8F%92%E4%BB%B6%E5%B8%82%E5%9C%BA&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/">文档</a> ｜
|
||
<a href="https://blog.astrbot.app/">Blog</a> ｜
|
||
<a href="https://astrbot.featurebase.app/roadmap">路线图</a> ｜
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/issues">问题提交</a>
|
||
</div>
|
||
|
||
AstrBot 是一个开源的一站式 Agentic 个人和群聊助手，可在 QQ、Telegram、企业微信、飞书、钉钉、Slack、等数十款主流即时通讯软件上部署，此外还内置类似 OpenWebUI 的轻量化 ChatUI，为个人、开发者和团队打造可靠、可扩展的对话式智能基础设施。无论是个人 AI 伙伴、智能客服、自动化助手，还是企业知识库，AstrBot 都能在你的即时通讯软件平台的工作流中快速构建 AI 应用。
|
||
|
||
|
||
|
||
## 主要功能
|
||
|
||
1. 💯 免费 & 开源。
|
||
2. ✨ AI 大模型对话，多模态，Agent，MCP，Skills，知识库，人格设定，自动压缩对话。
|
||
3. 🤖 支持接入 Dify、阿里云百炼、Coze 等智能体平台。
|
||
4. 🌐 多平台，支持 QQ、企业微信、飞书、钉钉、微信公众号、Telegram、Slack 以及[更多](#支持的消息平台)。
|
||
5. 📦 插件扩展，已有 1000+ 个插件可一键安装。
|
||
6. 🛡️ [Agent Sandbox](https://docs.astrbot.app/use/astrbot-agent-sandbox.html) 隔离化环境，安全地执行任何代码、调用 Shell、会话级资源复用。
|
||
7. 💻 WebUI 支持。
|
||
8. 🌈 Web ChatUI 支持，ChatUI 内置代理沙盒、网页搜索等。
|
||
9. 🌐 国际化（i18n）支持。
|
||
|
||
<br>
|
||
|
||
<table align="center">
|
||
<tr align="center">
|
||
<th>💙 角色扮演 & 情感陪伴</th>
|
||
<th>✨ 主动式 Agent</th>
|
||
<th>🚀 通用 Agentic 能力</th>
|
||
<th>🧩 1000+ 社区插件</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>
|
||
|
||
## 快速开始
|
||
|
||
#### Docker 部署(推荐 🥳)
|
||
|
||
推荐使用 Docker / Docker Compose 方式部署 AstrBot。
|
||
|
||
请参阅官方文档 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) 。
|
||
|
||
#### uv 部署
|
||
|
||
```bash
|
||
uv tool install astrbot
|
||
astrbot
|
||
```
|
||
|
||
#### 桌面应用部署（Tauri）
|
||
|
||
桌面应用仓库 [AstrBot-desktop](https://github.com/AstrBotDevs/AstrBot-desktop)。
|
||
|
||
支持多系统架构，安装包直接安装，开箱即用，最适合新手和懒人的一键桌面部署方案，不推荐服务器场景。
|
||
|
||
#### 启动器一键部署（AstrBot Launcher）
|
||
|
||
快速部署和多开方案，实现环境隔离，进入 [AstrBot Launcher](https://github.com/Raven95676/astrbot-launcher) 仓库，在 Releases 页最新版本下找到对应的系统安装包安装即可。
|
||
|
||
#### 宝塔面板部署
|
||
|
||
AstrBot 与宝塔面板合作，已上架至宝塔面板。
|
||
|
||
请参阅官方文档 [宝塔面板部署](https://astrbot.app/deploy/astrbot/btpanel.html) 。
|
||
|
||
#### 1Panel 部署
|
||
|
||
AstrBot 已由 1Panel 官方上架至 1Panel 面板。
|
||
|
||
请参阅官方文档 [1Panel 部署](https://astrbot.app/deploy/astrbot/1panel.html) 。
|
||
|
||
#### 在 雨云 上部署
|
||
|
||
AstrBot 已由雨云官方上架至云应用平台，可一键部署。
|
||
|
||
[](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0)
|
||
|
||
#### 在 Replit 上部署
|
||
|
||
社区贡献的部署方式。
|
||
|
||
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
||
|
||
#### Windows 一键安装器部署
|
||
|
||
请参阅官方文档 [使用 Windows 一键安装器部署 AstrBot](https://astrbot.app/deploy/astrbot/windows.html) 。
|
||
|
||
#### CasaOS 部署
|
||
|
||
社区贡献的部署方式。
|
||
|
||
请参阅官方文档 [CasaOS 部署](https://astrbot.app/deploy/astrbot/casaos.html) 。
|
||
|
||
#### 手动部署
|
||
|
||
首先安装 uv：
|
||
|
||
```bash
|
||
pip install uv
|
||
```
|
||
|
||
通过 Git Clone 安装 AstrBot：
|
||
|
||
```bash
|
||
git clone https://github.com/AstrBotDevs/AstrBot && cd AstrBot
|
||
uv run main.py
|
||
```
|
||
|
||
或者请参阅官方文档 [通过源码部署 AstrBot](https://astrbot.app/deploy/astrbot/cli.html) 。
|
||
|
||
#### 系统包管理器安装
|
||
|
||
##### Arch Linux
|
||
|
||
```bash
|
||
yay -S astrbot-git
|
||
# 或者使用 paru
|
||
paru -S astrbot-git
|
||
```
|
||
|
||
## 支持的消息平台
|
||
|
||
**官方维护**
|
||
|
||
- QQ
|
||
- OneBot v11 协议实现
|
||
- Telegram
|
||
- 企微应用 & 企微智能机器人
|
||
- 微信客服 & 微信公众号
|
||
- 飞书
|
||
- 钉钉
|
||
- Slack
|
||
- Discord
|
||
- LINE
|
||
- Satori
|
||
- Misskey
|
||
- Whatsapp (将支持)
|
||
|
||
**社区维护**
|
||
|
||
- [Matrix](https://github.com/stevessr/astrbot_plugin_matrix_adapter)
|
||
- [KOOK](https://github.com/wuyan1003/astrbot_plugin_kook_adapter)
|
||
- [VoceChat](https://github.com/HikariFroya/astrbot_plugin_vocechat)
|
||
|
||
## 支持的模型服务
|
||
|
||
**大模型服务**
|
||
|
||
- OpenAI 及兼容服务
|
||
- Anthropic
|
||
- Google Gemini
|
||
- Moonshot AI
|
||
- 智谱 AI
|
||
- DeepSeek
|
||
- Ollama (本地部署)
|
||
- LM Studio (本地部署)
|
||
- [AIHubMix](https://aihubmix.com/?aff=4bfH)
|
||
- [优云智算](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74)
|
||
- [302.AI](https://share.302.ai/rr1M3l)
|
||
- [小马算力](https://www.tokenpony.cn/3YPyf)
|
||
- [硅基流动](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot)
|
||
- [PPIO 派欧云](https://ppio.com/user/register?invited_by=AIOONE)
|
||
- ModelScope
|
||
- OneAPI
|
||
|
||
**LLMOps 平台**
|
||
|
||
- Dify
|
||
- 阿里云百炼应用
|
||
- Coze
|
||
|
||
**语音转文本服务**
|
||
|
||
- OpenAI Whisper
|
||
- SenseVoice
|
||
|
||
**文本转语音服务**
|
||
|
||
- OpenAI TTS
|
||
- Gemini TTS
|
||
- GPT-Sovits-Inference
|
||
- GPT-Sovits
|
||
- FishAudio
|
||
- Edge TTS
|
||
- 阿里云百炼 TTS
|
||
- Azure TTS
|
||
- Minimax TTS
|
||
- 火山引擎 TTS
|
||
|
||
## ❤️ 贡献
|
||
|
||
欢迎任何 Issues/Pull Requests！只需要将你的更改提交到此项目 ：)
|
||
|
||
### 如何贡献
|
||
|
||
你可以通过查看问题或帮助审核 PR（拉取请求）来贡献。任何问题或 PR 都欢迎参与，以促进社区贡献。当然，这些只是建议，你可以以任何方式进行贡献。对于新功能的添加，请先通过 Issue 讨论。
|
||
|
||
### 开发环境
|
||
|
||
AstrBot 使用 `ruff` 进行代码格式化和检查。
|
||
|
||
```bash
|
||
git clone https://github.com/AstrBotDevs/AstrBot
|
||
pip install pre-commit
|
||
pre-commit install
|
||
```
|
||
|
||
## 🌍 社区
|
||
|
||
### QQ 群组
|
||
|
||
- 1 群：322154837
|
||
- 3 群：630166526
|
||
- 5 群：822130018
|
||
- 6 群：753075035
|
||
- 7 群：743746109
|
||
- 8 群：1030353265
|
||
- 开发者群：975206796
|
||
|
||
### Telegram 群组
|
||
|
||
<a href="https://t.me/+hAsD2Ebl5as3NmY1"><img alt="Telegram_community" src="https://img.shields.io/badge/Telegram-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||
|
||
### Discord 群组
|
||
|
||
<a href="https://discord.gg/hAVk6tgV36"><img alt="Discord_community" src="https://img.shields.io/badge/Discord-AstrBot-purple?style=for-the-badge&color=76bad9"></a>
|
||
|
||
## ❤️ Special Thanks
|
||
|
||
特别感谢所有 Contributors 和插件开发者对 AstrBot 的贡献 ❤️
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=AstrBotDevs/AstrBot&max=200&columns=14" />
|
||
</a>
|
||
|
||
此外，本项目的诞生离不开以下开源项目的帮助：
|
||
|
||
- [NapNeko/NapCatQQ](https://github.com/NapNeko/NapCatQQ) - 伟大的猫猫框架
|
||
|
||
开源项目友情链接：
|
||
|
||
- [NoneBot2](https://github.com/nonebot/nonebot2) - 优秀的 Python 异步 ChatBot 框架
|
||
- [Koishi](https://github.com/koishijs/koishi) - 优秀的 Node.js ChatBot 框架
|
||
- [MaiBot](https://github.com/Mai-with-u/MaiBot) - 优秀的拟人化 AI ChatBot
|
||
- [nekro-agent](https://github.com/KroMiose/nekro-agent) - 优秀的 Agent ChatBot
|
||
- [LangBot](https://github.com/langbot-app/LangBot) - 优秀的多平台 AI ChatBot
|
||
- [ChatLuna](https://github.com/ChatLunaLab/chatluna) - 优秀的多平台 AI ChatBot Koishi 插件
|
||
- [Operit AI](https://github.com/AAswordman/Operit) - 优秀的 AI 智能助手 Android APP
|
||
|
||
## ⭐ Star History
|
||
|
||
> [!TIP]
|
||
> 如果本项目对您的生活 / 工作产生了帮助，或者您关注本项目的未来发展，请给项目 Star，这是我们维护这个开源项目的动力 <3
|
||
|
||
<div align="center">
|
||
|
||
[](https://star-history.com/#astrbotdevs/astrbot&Date)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
_陪伴与能力从来不应该是对立面。我们希望创造的是一个既能理解情绪、给予陪伴，也能可靠完成工作的机器人。_
|
||
|
||
_私は、高性能ですから!_
|
||
|
||
<img src="https://files.astrbot.app/watashiwa-koseino-desukara.gif" width="100"/>
|
||
|
||
</div>
|