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>
264 lines
16 KiB
Markdown
264 lines
16 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_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%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFZIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0LjYxNTZDNS4zMTUwMiAxNC4zOTk5IDUuNjAxNTYgMTQuMTEzNCA1LjYwMTU2IDEzLjc1OTlWMTEuMDM5OUM1LjYwMTU2IDEwLjY4NjQgNS4zMTUwMiAxMC4zOTk5IDQuOTYxNTYgMTAuMzk5OVoiIGZpbGw9IiNmZmYiLz4KPHBhdGggZD0iTTEzLjc1ODQgMS42MDAxSDExLjAzODRDMTAuNjg1IDEuNjAwMSAxMC4zOTg0IDEuODg2NjQgMTAuMzk4NCAyLjI0MDFWNC45NjAxQzEwLjM5ODQgNS4zMTM1NiAxMC42ODUgNS42MDAxIDExLjAzODQgNS42MDAxSDEzLjc1ODRDMTQuMTExOSA1LjYwMDEgMTQuMzk4NCA1LjMxMzU2IDE0LjM5ODQgNC45NjAxVjIuMjQwMUMxNC4zOTg0IDEuODg2NjQgMTQuMTExOSAxLjYwMDEgMTMuNzU4NCAxLjYwMDFZIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDRMNCAxMlpFIiBmaWxsPSIjZmZmIi8%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=%20&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://blog.astrbot.app/">Blog</a> ｜
|
||
<a href="https://astrbot.featurebase.app/roadmap">ロードマップ</a> ｜
|
||
<a href="https://github.com/AstrBotDevs/AstrBot/issues">Issue</a>
|
||
<a href="mailto:community@astrbot.app">Email Support</a>
|
||
</div>
|
||
|
||
AstrBot は、主要なインスタントメッセージングアプリと統合できるオープンソースのオールインワン Agent チャットボットプラットフォームです。個人、開発者、チームに信頼性が高くスケーラブルな会話型 AI インフラストラクチャを提供します。パーソナル AI コンパニオン、インテリジェントカスタマーサービス、オートメーションアシスタント、エンタープライズナレッジベースなど、AstrBot を使用すると、IM プラットフォームのワークフロー内で本番環境対応の AI アプリケーションを迅速に構築できます。
|
||
|
||
|
||
|
||
## 主な機能
|
||
|
||
1. 💯 無料 & オープンソース。
|
||
2. ✨ AI大規模言語モデル対話、マルチモーダル、Agent、MCP、Skills、ナレッジベース、ペルソナ設定、対話の自動圧縮。
|
||
3. 🤖 Dify、Alibaba Cloud Bailian（百煉）、Coze などのAgentプラットフォームへの接続をサポート。
|
||
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内にAgent Sandboxやウェブ検索などを内蔵。
|
||
9. 🌐 多言語対応（i18n）。
|
||
|
||
<br>
|
||
|
||
<table align="center">
|
||
<tr align="center">
|
||
<th>💙 ロールプレイ & 感情的な対話</th>
|
||
<th>✨ プロアクティブ・エージェント (Proactive Agent)</th>
|
||
<th>🚀 汎用 エージェント的能力</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` をインストールし、ローカル環境で AstrBot を起動してください。
|
||
|
||
```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 | 公式 |
|
||
| WeChat Work アプリケーション & WeChat Work インテリジェントボット | 公式 |
|
||
| WeChat カスタマーサービス & WeChat 公式アカウント | 公式 |
|
||
| Feishu (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 および互換サービス | 大規模言語モデルサービス |
|
||
| 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 プラットフォーム |
|
||
| Alibaba Cloud 百炼アプリケーション | LLMOps プラットフォーム |
|
||
| Coze | LLMOps プラットフォーム |
|
||
| OpenAI Whisper | 音声認識サービス |
|
||
| SenseVoice | 音声認識サービス |
|
||
| OpenAI TTS | 音声合成サービス |
|
||
| Gemini TTS | 音声合成サービス |
|
||
| GPT-Sovits-Inference | 音声合成サービス |
|
||
| GPT-Sovits | 音声合成サービス |
|
||
| FishAudio | 音声合成サービス |
|
||
| Edge TTS | 音声合成サービス |
|
||
| Alibaba Cloud 百炼 TTS | 音声合成サービス |
|
||
| Azure TTS | 音声合成サービス |
|
||
| Minimax TTS | 音声合成サービス |
|
||
| Volcano Engine TTS | 音声合成サービス |
|
||
|
||
## ❤️ コントリビューション
|
||
|
||
Issue や Pull Request は大歓迎です!このプロジェクトに変更を送信してください :)
|
||
|
||
### コントリビュート方法
|
||
|
||
Issue を確認したり、PR(プルリクエスト)のレビューを手伝うことで貢献できます。どんな Issue や 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
|
||
- 開発者群（正式）: 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
|
||
|
||
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>
|