DroidKali
326183a3fd
Updated the quick start command from 'astrbot' to 'astrbot run' across all language versions of README documentation for consistency and correctness. Co-authored-by: DroidKali <DroidKali@users.noreply.github.com> Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
267 lines
13 KiB
Markdown
267 lines
13 KiB
Markdown
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README_zh.md">简体中文</a> ｜
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README.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>
|
||
<a href="mailto:community@astrbot.app">Email</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>
|
||
|
||
## 快速開始
|
||
|
||
### 一鍵部署
|
||
|
||
對於想快速體驗 AstrBot、且熟悉命令列並能自行安裝 `uv` 環境的使用者，我們推薦使用 `uv` 一鍵部署方式 ⚡️。
|
||
|
||
```bash
|
||
uv tool install astrbot
|
||
astrbot init # 僅首次執行此命令以初始化環境
|
||
astrbot run
|
||
```
|
||
|
||
> 需要安裝 [uv](https://docs.astral.sh/uv/)。
|
||
|
||
> [!NOTE]
|
||
> 對於 macOS 使用者：由於 macOS 安全性檢查，首次執行 `astrbot` 指令可能需要較長時間（約 10-20 秒）。
|
||
|
||
更新 `astrbot`：
|
||
|
||
```bash
|
||
uv tool upgrade astrbot
|
||
```
|
||
|
||
### 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)。
|
||
|
||
### 在雨雲上部署
|
||
|
||
對於希望一鍵部署 AstrBot 且不想自行管理伺服器的使用者，我們推薦使用雨雲的一鍵雲端部署服務 ☁️：
|
||
|
||
[](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0)
|
||
|
||
### 桌面客戶端部署
|
||
|
||
對於希望在桌面端使用 AstrBot、並以 ChatUI 為主要入口的使用者，我們推薦使用 AstrBot App。
|
||
|
||
前往 [AstrBot-desktop](https://github.com/AstrBotDevs/AstrBot-desktop) 下載並安裝；此方式面向桌面使用，不建議伺服器場景。
|
||
|
||
### 啟動器部署
|
||
|
||
同樣在桌面端，對於希望快速部署並實現環境隔離多開的使用者，我們推薦使用 AstrBot Launcher。
|
||
|
||
前往 [AstrBot Launcher](https://github.com/Raven95676/astrbot-launcher) 下載並安裝。
|
||
|
||
### 在 Replit 上部署
|
||
|
||
Replit 部署由社群維護，適合線上示範與輕量試用情境。
|
||
|
||
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
||
|
||
### AUR
|
||
|
||
AUR 方式面向 Arch Linux 使用者，適合希望透過系統套件管理器安裝 AstrBot 的場景。
|
||
|
||
在終端執行下方命令安裝 `astrbot-git` 套件，安裝完成後即可啟動使用。
|
||
|
||
```bash
|
||
yay -S astrbot-git
|
||
```
|
||
|
||
**更多部署方式**
|
||
|
||
若你需要面板化或更高自訂程度的部署，可參考 [寶塔面板](https://astrbot.app/deploy/astrbot/btpanel.html)（BT Panel 應用商店安裝）、[1Panel](https://astrbot.app/deploy/astrbot/1panel.html)（1Panel 應用商店安裝）、[CasaOS](https://astrbot.app/deploy/astrbot/casaos.html)（NAS / 家用伺服器可視化部署）與 [手動部署](https://astrbot.app/deploy/astrbot/cli.html)（基於原始碼與 `uv` 的完整自訂安裝）。
|
||
|
||
## 支援的訊息平台
|
||
|
||
將 AstrBot 連接到你常用的聊天平台。
|
||
|
||
| 平台 | 維護方 |
|
||
|---------|---------------|
|
||
| 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) | 大型模型服務（API 閘道，支援所有模型） |
|
||
| [優雲智算](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 | 大型模型服務 |
|
||
| Dify | LLMOps 平台 |
|
||
| 阿里雲百煉應用 | LLMOps 平台 |
|
||
| Coze | LLMOps 平台 |
|
||
| 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 群組
|
||
|
||
- 9 群: 1076659624 (新)
|
||
- 10 群: 1078079676 (新)
|
||
- 1 群：322154837
|
||
- 3 群：630166526
|
||
- 5 群：822130018
|
||
- 6 群：753075035
|
||
- 7 群：743746109
|
||
- 8 群：1030353265
|
||
- 開發者群（闲聊吹水）：975206796
|
||
- 開發者群（正式）：1039761811
|
||
|
||
### 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>
|