香草味的纳西妲喵
297 lines
12 KiB
Markdown
297 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_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>
|
||
|
||
<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=%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/">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">Issue Tracker</a>
|
||
</div>
|
||
|
||
AstrBot is an open-source all-in-one Agent chatbot platform that integrates with mainstream instant messaging apps. It provides reliable and scalable conversational AI infrastructure for individuals, developers, and teams. Whether you're building a personal AI companion, intelligent customer service, automation assistant, or enterprise knowledge base, AstrBot enables you to quickly build production-ready AI applications within your IM platform workflows.
|
||
|
||
|
||
|
||
## Key Features
|
||
|
||
1. 💯 Free & Open Source.
|
||
2. ✨ AI LLM Conversations, Multimodal, Agent, MCP, Skills, Knowledge Base, Persona Settings, Auto Context Compression.
|
||
3. 🤖 Supports integration with Dify, Alibaba Cloud Bailian, Coze, and other agent platforms.
|
||
4. 🌐 Multi-Platform: QQ, WeChat Work, Feishu, DingTalk, WeChat Official Accounts, Telegram, Slack, and [more](#supported-messaging-platforms).
|
||
5. 📦 Plugin Extensions with nearly 800 plugins available for one-click installation.
|
||
6. 🛡️ [Agent Sandbox](https://docs.astrbot.app/use/astrbot-agent-sandbox.html) for isolated, safe execution of code, shell calls, and session-level resource reuse.
|
||
7. 💻 WebUI Support.
|
||
8. 🌈 Web ChatUI Support with built-in agent sandbox and web search.
|
||
9. 🌐 Internationalization (i18n) Support.
|
||
|
||
<br>
|
||
|
||
<table align="center">
|
||
<tr align="center">
|
||
<th>💙 Role-playing & Emotional Companionship</th>
|
||
<th>✨ Proactive Agent</th>
|
||
<th>🚀 General Agentic Capabilities</th>
|
||
<th>🧩 900+ 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
|
||
|
||
#### Docker Deployment (Recommended 🥳)
|
||
|
||
We recommend deploying AstrBot using Docker or Docker Compose.
|
||
|
||
Please refer to the official documentation: [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot).
|
||
|
||
#### uv Deployment
|
||
|
||
```bash
|
||
uv tool install astrbot
|
||
astrbot
|
||
```
|
||
|
||
#### System Package Manager Installation
|
||
|
||
##### Arch Linux
|
||
|
||
```bash
|
||
yay -S astrbot-git
|
||
# or use paru
|
||
paru -S astrbot-git
|
||
```
|
||
|
||
#### BT-Panel Deployment
|
||
|
||
AstrBot has partnered with BT-Panel and is now available in their marketplace.
|
||
|
||
Please refer to the official documentation: [BT-Panel Deployment](https://astrbot.app/deploy/astrbot/btpanel.html).
|
||
|
||
#### 1Panel Deployment
|
||
|
||
AstrBot has been officially listed on the 1Panel marketplace.
|
||
|
||
Please refer to the official documentation: [1Panel Deployment](https://astrbot.app/deploy/astrbot/1panel.html).
|
||
|
||
#### Deploy on RainYun
|
||
|
||
AstrBot has been officially listed on RainYun's cloud application platform with one-click deployment.
|
||
|
||
[](https://app.rainyun.com/apps/rca/store/5994?ref=NjU1ODg0)
|
||
|
||
#### Deploy on Replit
|
||
|
||
Community-contributed deployment method.
|
||
|
||
[](https://repl.it/github/AstrBotDevs/AstrBot)
|
||
|
||
#### Windows One-Click Installer
|
||
|
||
Please refer to the official documentation: [Deploy AstrBot with Windows One-Click Installer](https://astrbot.app/deploy/astrbot/windows.html).
|
||
|
||
#### CasaOS Deployment
|
||
|
||
Community-contributed deployment method.
|
||
|
||
Please refer to the official documentation: [CasaOS Deployment](https://astrbot.app/deploy/astrbot/casaos.html).
|
||
|
||
#### Manual Deployment
|
||
|
||
First, install uv:
|
||
|
||
```bash
|
||
pip install uv
|
||
```
|
||
|
||
Install AstrBot via Git Clone:
|
||
|
||
```bash
|
||
git clone https://github.com/AstrBotDevs/AstrBot && cd AstrBot
|
||
uv run main.py
|
||
```
|
||
|
||
Or refer to the official documentation: [Deploy AstrBot from Source](https://astrbot.app/deploy/astrbot/cli.html).
|
||
|
||
#### System Package Manager Installation
|
||
|
||
##### Arch Linux
|
||
|
||
```bash
|
||
yay -S astrbot-git
|
||
# or use paru
|
||
paru -S astrbot-git
|
||
```
|
||
|
||
#### Desktop (Tauri)
|
||
|
||
Desktop packaging has moved to a standalone Tauri repository: [https://github.com/AstrBotDevs/AstrBot-desktop](https://github.com/AstrBotDevs/AstrBot-desktop).
|
||
|
||
## Supported Messaging Platforms
|
||
|
||
**Officially Maintained**
|
||
|
||
- QQ (Official Platform & OneBot)
|
||
- Telegram
|
||
- WeChat Work Application & WeChat Work Intelligent Bot
|
||
- WeChat Customer Service & WeChat Official Accounts
|
||
- Feishu (Lark)
|
||
- DingTalk
|
||
- Slack
|
||
- Discord
|
||
- Satori
|
||
- Misskey
|
||
- LINE
|
||
- WhatsApp (Coming Soon)
|
||
|
||
**Community Maintained**
|
||
|
||
- [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)
|
||
|
||
## Supported Model Services
|
||
|
||
**LLM Services**
|
||
|
||
- OpenAI and Compatible Services
|
||
- Anthropic
|
||
- Google Gemini
|
||
- Moonshot AI
|
||
- Zhipu AI
|
||
- DeepSeek
|
||
- Ollama (Self-hosted)
|
||
- LM Studio (Self-hosted)
|
||
- [CompShare](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74)
|
||
- [302.AI](https://share.302.ai/rr1M3l)
|
||
- [TokenPony](https://www.tokenpony.cn/3YPyf)
|
||
- [SiliconFlow](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot)
|
||
- [PPIO Cloud](https://ppio.com/user/register?invited_by=AIOONE)
|
||
- ModelScope
|
||
- OneAPI
|
||
|
||
**LLMOps Platforms**
|
||
|
||
- Dify
|
||
- Alibaba Cloud Bailian Applications
|
||
- Coze
|
||
|
||
**Speech-to-Text Services**
|
||
|
||
- OpenAI Whisper
|
||
- SenseVoice
|
||
|
||
**Text-to-Speech Services**
|
||
|
||
- OpenAI TTS
|
||
- Gemini TTS
|
||
- GPT-Sovits-Inference
|
||
- GPT-Sovits
|
||
- FishAudio
|
||
- Edge TTS
|
||
- Alibaba Cloud Bailian TTS
|
||
- Azure TTS
|
||
- Minimax TTS
|
||
- Volcano Engine TTS
|
||
|
||
## ❤️ Contributing
|
||
|
||
Issues and Pull Requests are always welcome! Feel free to submit your changes to this project :)
|
||
|
||
### How to Contribute
|
||
|
||
You can contribute by reviewing issues or helping with pull request reviews. Any issues or PRs are welcome to encourage community participation. Of course, these are just suggestions—you can contribute in any way you like. For adding new features, please discuss through an Issue first.
|
||
|
||
### Development Environment
|
||
|
||
AstrBot uses `ruff` for code formatting and linting.
|
||
|
||
```bash
|
||
git clone https://github.com/AstrBotDevs/AstrBot
|
||
pip install pre-commit
|
||
pre-commit install
|
||
```
|
||
|
||
## 🌍 Community
|
||
|
||
### QQ Groups
|
||
|
||
- Group 1: 322154837
|
||
- Group 3: 630166526
|
||
- Group 5: 822130018
|
||
- Group 6: 753075035
|
||
- Group 7: 743746109
|
||
- Group 8: 1030353265
|
||
- Developer Group: 975206796
|
||
|
||
### Telegram Group
|
||
|
||
<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 Server
|
||
|
||
<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
|
||
|
||
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>
|
||
|
||
Additionally, the birth of this project would not have been possible without the help of the following open-source projects:
|
||
|
||
- [NapNeko/NapCatQQ](https://github.com/NapNeko/NapCatQQ) - The amazing cat framework
|
||
|
||
## ⭐ Star History
|
||
|
||
> [!TIP]
|
||
> If this project has helped you in your life or work, or if you're interested in its future development, please give the project a Star. It's the driving force behind maintaining 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 at odds. What we aim to create is a robot that can understand emotions, provide genuine companionship, and reliably accomplish tasks._
|
||
|
||
_私は、高性能ですから!_
|
||
|
||
<img src="https://files.astrbot.app/watashiwa-koseino-desukara.gif" width="100"/>
|
||
</div>
|