mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-18 10:00:40 +08:00
290 lines
17 KiB
Markdown
290 lines
17 KiB
Markdown
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/blob/master/README.md">English</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_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>
|
||
|
||
<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=%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%83%9E%E3%83%BC%E3%82%B1%E3%83%83%E3%83%88&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://astrbot.app/">ドキュメント</a> ｜
|
||
<a href="https://blog.astrbot.app/">ブログ</a> ｜
|
||
<a href="https://astrbot.featurebase.app/roadmap">ロードマップ</a> ｜
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/issues">課題の提出</a>
|
||
<a href="mailto:community@astrbot.app">メール</a>
|
||
|
||
</div>
|
||
|
||
AstrBot は、QQ、Telegram、WeCom (企業微信)、Lark (飛書)、DingTalk (釘釘)、Slack など、数十の主要なインスタントメッセージングソフトウェアに導入可能な、オープンソースのワンストップ Agentic 個人およびグループチャットアシスタントです。さらに、OpenWebUI に似た軽量な ChatUI も内蔵しており、個人、開発者、チーム向けに信頼性が高く拡張可能な対話型 AI インフラストラクチャを構築します。個人の AI パートナー、インテリジェントなカスタマーサービス、自動化アシスタント、企業のナレッジベースなど、AstrBot はお使いのメッセージングプラットフォームのワークフロー内で AI アプリケーションを迅速に構築できます。
|
||
|
||
|
||
|
||
## 主な機能
|
||
|
||
1. 💯 無料 & オープンソース。
|
||
2. ✨ AI 大規模モデル対話、マルチモーダル、エージェント、MCP、スキル、ナレッジベース、人格設定、対話の自動圧縮。
|
||
3. 🤖 Dify、Aliyun Bailian、Coze などのエージェントプラットフォームとの連携をサポート。
|
||
4. 🌐 マルチプラットフォーム対応。QQ、WeCom、Lark、DingTalk、WeChat 公式アカウント、Telegram、Slack、および[その他](#対応メッセージングプラットフォーム)をサポート。
|
||
5. 📦 プラグイン拡張。1000 以上のプラグインがあり、ワンクリックでインストール可能。
|
||
6. 🛡️ [Agent Sandbox](https://docs.astrbot.app/use/astrbot-agent-sandbox.html)。隔離された環境で、任意のコードの実行、Shell の呼び出し、セッションレベルのリソースの再利用を安全に行えます。
|
||
7. 💻 WebUI 対応。
|
||
8. 🌈 Web ChatUI 対応。ChatUI にはエージェントサンドボックス、Web 検索などが組み込まれています。
|
||
9. 🌐 国際化 (i18n) 対応。
|
||
|
||
<br>
|
||
|
||
<table align="center">
|
||
<tr align="center">
|
||
<th>💙 ロールプレイング & 感情的な交友</th>
|
||
<th>✨ 能動的エージェント</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) を参照してください。
|
||
|
||
### RainYun でのデプロイ
|
||
|
||
AstrBot をワンクリックでデプロイしたいが、サーバーを自分で管理したくないユーザーには、RainYun のワンクリッククラウドデプロイサービスをお勧めします ☁️:
|
||
|
||
[](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
|
||
```
|
||
|
||
**その他のデプロイ方法**
|
||
|
||
パネル化されたデプロイや、より高度なカスタマイズが必要な場合は、[BT Panel](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** | 公式管理 |
|
||
| **WeCom アプリ & WeCom スマートボット** | 公式管理 |
|
||
| **WeChat カスタマーサービス & 公式アカウント** | 公式管理 |
|
||
| **Lark (飛書)** | 公式管理 |
|
||
| **DingTalk (釘釘)** | 公式管理 |
|
||
| **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 API 互換サービス |
|
||
| OpenAI | LLM |
|
||
| Anthropic | LLM |
|
||
| Google Gemini | LLM |
|
||
| Moonshot AI | LLM |
|
||
| Zhipu AI | LLM |
|
||
| DeepSeek | LLM |
|
||
| Ollama (ローカルデプロイ) | LLM |
|
||
| LM Studio (ローカルデプロイ) | LLM |
|
||
| [AIHubMix](https://aihubmix.com/?aff=4bfH) | LLM (API ゲートウェイ, すべてのモデルをサポート) |
|
||
| [Uyun AI](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74) | LLM (API ゲートウェイ, すべてのモデルをサポート) |
|
||
| [SiliconFlow](https://docs.siliconflow.cn/cn/usercases/use-siliconcloud-in-astrbot) | LLM (API ゲートウェイ, すべてのモデルをサポート) |
|
||
| [PPIO](https://ppio.com/user/register?invited_by=AIOONE) | LLM (API ゲートウェイ, すべてのモデルをサポート) |
|
||
| [302.AI](https://share.302.ai/rr1M3l) | LLM (API ゲートウェイ, すべてのモデルをサポート)|
|
||
| [TokenPony](https://www.tokenpony.cn/3YPyf) | LLM (API ゲートウェイ, すべてのモデルをサポート)|
|
||
| ModelScope | LLM |
|
||
| OneAPI | LLM |
|
||
| Dify | LLMOps プラットフォーム |
|
||
| Aliyun Bailian アプリ | LLMOps プラットフォーム |
|
||
| Coze | LLMOps プラットフォーム |
|
||
| OpenAI Whisper | 音声テキスト変換 |
|
||
| SenseVoice | 音声テキスト変換 |
|
||
| OpenAI TTS | テキスト読み上げ |
|
||
| Gemini TTS | テキスト読み上げ |
|
||
| GPT-Sovits-Inference | テキスト読み上げ |
|
||
| GPT-Sovits | テキスト読み上げ |
|
||
| FishAudio | テキスト読み上げ |
|
||
| Edge TTS | テキスト読み上げ |
|
||
| Aliyun Bailian TTS | テキスト読み上げ |
|
||
| Azure TTS | テキスト読み上げ |
|
||
| Minimax TTS | テキスト読み上げ |
|
||
| Volcengine TTS | テキスト読み上げ |
|
||
|
||
## ❤️ 貢献
|
||
|
||
Issues/Pull Requests はいつでも歓迎します！変更をこのプロジェクトに送信するだけです :)
|
||
|
||
### 貢献方法
|
||
|
||
問題の確認や PR (プルリクエスト) のレビューを手伝うことで貢献できます。コミュニティへの貢献を促進するために、どのような問題や PR も歓迎します。もちろん、これらは提案に過ぎず、どのような方法でも貢献できます。新機能の追加については、まず Issue で議論してください。
|
||
機能的な PR は `dev` ブランチにマージすることをお勧めします。テスト修正後にメインブランチにマージされ、新しいバージョンとしてリリースされます。
|
||
|
||
### 開発環境
|
||
|
||
AstrBot はコードのフォーマットとチェックに `ruff` を使用しています。
|
||
|
||
```bash
|
||
git clone https://github.com/AstrBotDevs/AstrBot
|
||
git switch dev # 開発ブランチに切り替え
|
||
pip install pre-commit # または uv tool install pre-commit
|
||
pre-commit install
|
||
```
|
||
`uv` をローカルにインストールしてテストすることをお勧めします
|
||
```bash
|
||
uv tool install -e . --force
|
||
astrbot init
|
||
astrbot run
|
||
```
|
||
フロントエンドのデバッグ
|
||
```bash
|
||
astrbot run --backend-only
|
||
cd dashboard
|
||
bun install # または pnpm など
|
||
bun dev
|
||
```
|
||
|
||
### QQ グループ
|
||
|
||
- グループ 9: 1076659624 (新)
|
||
- グループ 10: 1078079676 (新)
|
||
- グループ 1: 322154837
|
||
- グループ 3: 630166526
|
||
- グループ 5: 822130018
|
||
- グループ 6: 753075035
|
||
- グループ 7: 743746109
|
||
- グループ 8: 1030353265
|
||
- 開発者グループ (雑談): 975206796
|
||
- 開発者グループ (公式): 1039761811
|
||
|
||
### Discord チャンネル
|
||
|
||
- [Discord](https://discord.gg/hAVk6tgV36)
|
||
|
||
## ❤️ Special Thanks
|
||
|
||
AstrBot に貢献してくださったすべての Contributors とプラグイン開発者に感謝します ❤️
|
||
|
||
<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 アプリ
|
||
|
||
## ⭐ 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> |