mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-19 18:47:41 +08:00
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>
293 lines
12 KiB
Markdown
293 lines
12 KiB
Markdown
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README.md">简体中文</a> ｜
|
||
<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_fr.md">Français</a> ｜
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_ru.md">Русский</a>
|
||
|
||
<br>
|
||
|
||
<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=%E5%80%8B&label=%E6%8F%92%E4%BB%B6%E5%B8%82%E5%A0%B4&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 是一個開源的一站式 Agent 聊天機器人平台，可接入主流即時通訊軟體，為個人、開發者和團隊打造可靠、可擴展的對話式智慧基礎設施。無論是個人 AI 夥伴、智慧客服、自動化助手，還是企業知識庫，AstrBot 都能在您的即時通訊軟體平台的工作流程中快速構建生產可用的 AI 應用程式。
|
||
|
||
|
||
|
||
## 主要功能
|
||
|
||
1. 💯 免費 & 開源。
|
||
2. ✨ AI 大模型對話，多模態，Agent，MCP，Skills，知識庫，人格設定，自動壓縮對話。
|
||
3. 🤖 支援接入 Dify、阿里雲百煉、Coze 等智慧體 (Agent) 平台。
|
||
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 內置代理沙盒 (Agent Sandbox)、網頁搜尋等。
|
||
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）
|
||
- Telegram
|
||
- 企微應用 & 企微智慧機器人
|
||
- 微信客服 & 微信公眾號
|
||
- 飛書
|
||
- 釘釘
|
||
- Slack
|
||
- Discord
|
||
- Satori
|
||
- Misskey
|
||
- LINE
|
||
- 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（本機部署）
|
||
- [優雲智算](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
|
||
- 開發者群：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) - 偉大的貓貓框架
|
||
|
||
## ⭐ 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>
|