AstrBot Documentation

File: README.md Copy Chapter

Documentation ｜
Blog ｜
Roadmap ｜
Issue Tracker ｜
Email Support

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 Copy Chapter

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.
5. 📦 Plugin Extensions with 1000+ plugins available for one-click installation.
6. 🛡️ Agent Sandbox 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.

Quick Start Copy Chapter

One-Click Cloud Deployment (RainYun) Copy Section

For users who want one-click 24-hour-online deployment and do not want to manage servers themselves, we recommend RainYun's one-click cloud deployment service ☁️:

One-Click Deployment Copy Section

[!NOTE]
Requires uv to be installed.
For macOS users: due to macOS security checks, the first run of the astrbot command may take longer (about 10-20s).

For users who want to quickly experience AstrBot, are familiar with command-line usage, and can install a uv environment on their own, we recommend the uv one-click deployment method ⚡️:

uv tool install astrbot --python 3.12
astrbot init # Only execute this command for the first time to initialize the environment
astrbot run

Update astrbot:

uv tool upgrade astrbot --python 3.12

Docker Deployment Copy Section

For users familiar with containers and looking for a more stable, production-ready deployment method, we recommend deploying AstrBot with Docker / Docker Compose.

Please refer to the official documentation: Deploy AstrBot with Docker.

Desktop Application Deployment Copy Section

For users who want to use AstrBot on desktop and mainly use ChatUI, we recommend AstrBot App.

Visit AstrBot-desktop to download and install; this method is designed for desktop usage and is not recommended for server scenarios.

Launcher Deployment Copy Section

For desktop users who also want fast deployment and isolated multi-instance usage, we recommend AstrBot Launcher.

Visit AstrBot Launcher to download and install.

More deployment methods

If you need panel-based management or deeper customization, see BT-Panel Deployment for BT Panel app-store setup, 1Panel Deployment for 1Panel app-market deployment, CasaOS Deployment for NAS/home-server visual deployment, and Manual Deployment for fully custom source-based installation with uv.

❤️ Sponsors Copy Chapter

Welcome to sponsor us via Afdian or contact us.

Supported Messaging Platforms Copy Chapter

Connect AstrBot to your favorite chat platform.

Supported Model Services Copy Chapter

❤️ Contributing Copy Chapter

Issues and Pull Requests are always welcome! Feel free to submit your changes to this project :)

How to Contribute Copy Section

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 Copy Section

AstrBot uses ruff for code formatting and linting.

git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install

🌍 Community Copy Chapter

QQ Groups Copy Section

We have 15+ chat groups, please see: Community for details.

Discord Server Copy Section

❤️ Special Thanks Copy Chapter

Special thanks to all Contributors and plugin developers for their contributions to AstrBot ❤️

Open Source Friends ❤️

• NapNeko/NapCatQQ - The amazing cat framework
• Mai-with-u/MaiBot - The powerful "digital life" in your QQ!

⭐ Star History Copy Chapter

[!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

File: astrbot/core/star/README.md Copy Chapter

AstrBot Star

AstrBot Star 就是插件。

在 AstrBot v4.0 版本后，AstrBot 内部将插件命名为 star。插件的 handler 称作 star_handler。

File: dashboard/src/components/folder/README.md Copy Chapter

通用文件夹管理组件库

这是一个可复用的文件夹管理 UI 组件库，提供了完整的文件夹树、面包屑导航、拖放操作等功能。可用于管理各种类型的项目，如 Persona、模板、知识库等。

组件列表 Copy Chapter

Composable Copy Chapter

`useFolderManager` Copy Section

提供文件夹管理的核心逻辑，包括状态管理、导航、CRUD 操作等。

import { useFolderManager } from '@/components/folder';

const {
  // 状态
  folderTree,
  currentFolderId,
  currentFolders,
  breadcrumbPath,
  expandedFolderIds,
  loading,
  treeLoading,
  
  // 计算属性
  currentFolderName,
  breadcrumbItems,
  
  // 方法
  loadFolderTree,
  navigateToFolder,
  refreshCurrentFolder,
  createFolder,
  updateFolder,
  deleteFolder,
  moveFolder,
  toggleFolderExpansion,
  setFolderExpansion,
  findFolderInTree,
  findPathToFolder,
  filterTreeBySearch,
} = useFolderManager({
  operations: {
    loadFolderTree: async () => {
      const response = await pluginExtensionApi.get('your-module/folder/tree');
      return response.data.data;
    },
    loadSubFolders: async (parentId) => {
      const response = await pluginExtensionApi.get('your-module/folder/list', {
        params: { parent_id: parentId ?? '' }
      });
      return response.data.data;
    },
    createFolder: async (data) => {
      const response = await pluginExtensionApi.post('your-module/folder/create', data);
      return response.data.data.folder;
    },
    updateFolder: async (data) => {
      await pluginExtensionApi.post('your-module/folder/update', data);
    },
    deleteFolder: async (folderId) => {
      await pluginExtensionApi.post('your-module/folder/delete', { folder_id: folderId });
    },
  },
  rootFolderName: '根目录',
  autoLoad: true,
});

使用示例 Copy Chapter

基础用法 Copy Section

/* Detailed source-code truncated for AI context efficiency. */

类型定义 Copy Chapter

// 文件夹基础接口
interface Folder {
  folder_id: string;
  name: string;
  parent_id: string | null;
  description?: string | null;
  sort_order?: number;
  created_at?: string;
  updated_at?: string;
}

// 文件夹树节点接口
interface FolderTreeNode extends Folder {
  children: FolderTreeNode[];
}

// 拖放事件数据
interface DropEventData {
  item_id: string;
  item_type: string;
  target_folder_id: string | null;
  source_data?: any;
}

// 创建文件夹数据
interface CreateFolderData {
  name: string;
  parent_id?: string | null;
  description?: string;
}

国际化支持 Copy Chapter

所有组件都支持通过 labels prop 自定义文本，方便集成到不同的国际化方案中：

拖放支持 Copy Chapter

组件内置了拖放支持，可以通过 acceptDropTypes 指定接受的拖放类型：

<script setup>
function handleDrop({ item_id, item_type, target_folder_id, source_data }) {
  if (item_type === 'persona') {
    // 移动 persona 到目标文件夹
    movePersonaToFolder(item_id, target_folder_id);
  }
}
</script>

与 Pinia Store 集成 Copy Chapter

如果你更喜欢使用 Pinia Store 管理状态，可以参考现有的 personaStore.ts 实现：

// stores/myFolderStore.ts
import { defineStore } from 'pinia';
import type { FolderTreeNode, Folder } from '@/components/folder';

export const useMyFolderStore = defineStore('myFolder', {
  state: () => ({
    folderTree: [] as FolderTreeNode[],
    currentFolderId: null as string | null,
    currentFolders: [] as Folder[],
    // ...
  }),
  
  actions: {
    async loadFolderTree() {
      // ...
    },
    // ...
  },
});

File: dashboard/README.md Copy Chapter

AstrBot 管理面板

基于 CodedThemes/Berry 模板开发。

环境变量 Copy Chapter

• VITE_ASTRBOT_RELEASE_BASE_URL（可选）
  • 默认值：https://github.com/AstrBotDevs/AstrBot/releases
  • 用途：管理面板内“更新到最新版本”外部跳转所使用的 release 基地址。集成方可按需覆盖（例如 Desktop 指向其自身发布页）。
  • 建议传入仓库的 .../releases 基地址（不带 /latest）。

File: README_fr.md Copy Chapter

Documentation ｜
Blog ｜
Feuille de route ｜
Signaler un problème ｜
Email Support

AstrBot est une plateforme de chatbot Agent tout-en-un open source qui s'intègre aux principales applications de messagerie instantanée. Elle fournit une infrastructure d'IA conversationnelle fiable et évolutive pour les particuliers, les développeurs et les équipes. Que vous construisiez un compagnon IA personnel, un service client intelligent, un assistant d'automatisation ou une base de connaissances d'entreprise, AstrBot vous permet de créer rapidement des applications d'IA prêtes pour la production dans les flux de travail de votre plateforme de messagerie.

Fonctionnalités principales Copy Chapter

1. 💯 Gratuit & Open Source.
2. ✨ Dialogue avec de grands modèles d'IA, multimodal, Agent, MCP, Skills, Base de connaissances, Paramétrage de personnalité, compression automatique des dialogues.
3. 🤖 Prise en charge de l'accès aux plateformes d'Agents telles que Dify, Alibaba Cloud Bailian, Coze, etc.
4. 🌐 Multiplateforme : supporte QQ, WeChat Enterprise, Feishu, DingTalk, Comptes officiels WeChat, Telegram, Slack et plus encore.
5. 📦 Extension par plugins, avec plus de 1000 plugins déjà disponibles pour une installation en un clic.
6. 🛡️ Environnement isolé Agent Sandbox : exécution sécurisée de code, appels Shell et réutilisation des ressources au niveau de la session.
7. 💻 Support WebUI.
8. 🌈 Support Web ChatUI, avec sandbox d'agent intégrée, recherche web, etc.
9. 🌐 Support de l'internationalisation (i18n).

Démarrage rapide Copy Chapter

Déploiement cloud en un clic (RainYun) Copy Section

Pour les utilisateurs qui souhaitent déployer AstrBot en un clic, le garder en ligne 24 heures sur 24 et ne pas gérer eux-mêmes de serveur, nous recommandons le service de déploiement cloud en un clic de RainYun ☁️ :

Déploiement en un clic Copy Section

[!NOTE]
uv doit être installé.
Pour les utilisateurs macOS : en raison des vérifications de sécurité de macOS, la première exécution de la commande astrbot peut prendre plus de temps (environ 10-20s).

Pour les utilisateurs qui veulent découvrir AstrBot rapidement, qui sont familiers avec la ligne de commande et peuvent installer eux-mêmes l'environnement uv, nous recommandons la méthode de déploiement en un clic avec uv ⚡️ :

uv tool install astrbot --python 3.12
astrbot init # Exécutez cette commande uniquement la première fois pour initialiser l'environnement
astrbot run

Mettre à jour astrbot :

uv tool upgrade astrbot --python 3.12

Déploiement Docker Copy Section

Pour les utilisateurs familiers avec les conteneurs et qui souhaitent une méthode plus stable et adaptée à la production, nous recommandons de déployer AstrBot avec Docker / Docker Compose.

Veuillez consulter la documentation officielle Déployer AstrBot avec Docker.

Déploiement de l'application de bureau Copy Section

Pour les utilisateurs qui veulent utiliser AstrBot sur desktop et passer principalement par ChatUI, nous recommandons AstrBot App.

Accédez à AstrBot-desktop pour télécharger et installer l'application ; cette méthode est conçue pour un usage desktop et n'est pas recommandée pour les scénarios serveur.

Déploiement avec le lanceur Copy Section

Également sur desktop, pour les utilisateurs qui souhaitent un déploiement rapide avec isolation d'environnement et multi-instances, nous recommandons AstrBot Launcher.

Accédez à AstrBot Launcher pour télécharger et installer.

Autres méthodes de déploiement

Si vous avez besoin d'une gestion par panneau ou d'une personnalisation plus poussée, consultez Déploiement BT-Panel pour une installation via BT Panel, Déploiement 1Panel pour le marketplace 1Panel, Déploiement CasaOS pour un déploiement visuel sur NAS/serveur domestique, et Déploiement manuel pour une installation complète depuis les sources avec uv.

❤️ Sponsors Copy Chapter

Vous pouvez nous soutenir via Afdian ou nous contacter par e-mail.

Plateformes de messagerie prises en charge Copy Chapter

Connectez AstrBot à vos plateformes de chat préférées.

Services de modèles pris en charge Copy Chapter

❤️ Contribuer Copy Chapter

Les Issues et Pull Requests sont toujours les bienvenues ! N'hésitez pas à soumettre vos modifications à ce projet :)

Comment contribuer Copy Section

Vous pouvez contribuer en examinant les issues ou en aidant à la revue des pull requests. Toutes les issues ou PRs sont les bienvenues pour encourager la participation de la communauté. Bien sûr, ce ne sont que des suggestions - vous pouvez contribuer de la manière que vous souhaitez. Pour l'ajout de nouvelles fonctionnalités, veuillez d'abord en discuter via une Issue.

Environnement de développement Copy Section

AstrBot utilise ruff pour le formatage et le linting du code.

git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install

🌍 Communauté Copy Chapter

Groupes QQ Copy Section

Nous avons plus de 15 groupes de discussion. Consultez la page Communauté pour plus de détails.

Serveur Discord Copy Section

❤️ Remerciements spéciaux Copy Chapter

Un grand merci à tous les contributeurs et développeurs de plugins pour leurs contributions à AstrBot ❤️

Amis de l'open source ❤️

• NapNeko/NapCatQQ - L'incroyable framework félin
• Mai-with-u/MaiBot - La puissante « vie numérique » sur QQ !

⭐ Historique des étoiles Copy Chapter

[!TIP]
Si ce projet vous a aidé dans votre vie ou votre travail, ou si vous êtes intéressé par son développement futur, veuillez donner une étoile au projet. C'est la force motrice derrière la maintenance de ce projet open source <3

File: README_ja.md Copy Chapter

ドキュメント ｜
Blog ｜
ロードマップ ｜
Issue ｜
Email Support

AstrBot は、主要なインスタントメッセージングアプリと統合できるオープンソースのオールインワン Agent チャットボットプラットフォームです。個人、開発者、チームに信頼性が高くスケーラブルな会話型 AI インフラストラクチャを提供します。パーソナル AI コンパニオン、インテリジェントカスタマーサービス、オートメーションアシスタント、エンタープライズナレッジベースなど、AstrBot を使用すると、IM プラットフォームのワークフロー内で本番環境対応の AI アプリケーションを迅速に構築できます。

主な機能 Copy Chapter

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：コードの安全な実行、Shell呼び出し、セッションレベルのリソース再利用。
7. 💻 WebUI 対応。
8. 🌈 Web ChatUI 対応：ChatUI内にAgent Sandboxやウェブ検索などを内蔵。
9. 🌐 多言語対応（i18n）。

クイックスタート Copy Chapter

RainYun ワンクリッククラウドデプロイ Copy Section

AstrBot をワンクリックで 24 時間稼働させたいものの、サーバーを自分で管理したくないユーザーには、RainYun のワンクリッククラウドデプロイサービスをおすすめします ☁️:

ワンクリックデプロイ Copy Section

[!NOTE]
uv のインストールが必要です。
macOS ユーザーの場合：macOS のセキュリティチェックにより、astrbot コマンドの初回実行に時間がかかる場合があります（約 10〜20 秒）。

AstrBot を素早く試したいユーザーで、コマンドラインに慣れており uv 環境を自分でインストールできる場合は、uv のワンクリックデプロイをおすすめします ⚡️:

uv tool install astrbot --python 3.12
astrbot init # 初回のみ実行して環境を初期化します
astrbot run

astrbot の更新：

uv tool upgrade astrbot --python 3.12

Docker デプロイ Copy Section

コンテナ運用に慣れており、より安定した本番向けのデプロイ方法を求めるユーザーには、Docker / Docker Compose での AstrBot デプロイをおすすめします。

公式ドキュメント Docker を使用した AstrBot のデプロイ をご参照ください。

デスクトップアプリのデプロイ Copy Section

デスクトップで AstrBot を使い、主に ChatUI を入口として利用するユーザーには、AstrBot App をおすすめします。

AstrBot-desktop からダウンロードしてインストールしてください。この方式はデスクトップ向けであり、サーバー用途には推奨されません。

ランチャーのデプロイ Copy Section

同じくデスクトップで、素早くデプロイしつつ環境を分離して多重起動したいユーザーには、AstrBot Launcher をおすすめします。

AstrBot Launcher からダウンロードしてインストールしてください。

その他のデプロイ方法

パネル操作での導入やより高度なカスタマイズが必要な場合は、宝塔パネルデプロイ（BT Panel 経由の導入）、1Panel デプロイ（1Panel アプリマーケット経由）、CasaOS デプロイ（NAS / ホームサーバー向け可視化導入）、手動デプロイ（uv とソースベースのフルカスタム導入）を参照してください。

❤️ スポンサー Copy Chapter

Afdian またはメールからのご支援を歓迎します。

サポートされているメッセージプラットフォーム Copy Chapter

AstrBot をよく使うチャットプラットフォームに接続できます。

サポートされているモデルサービス Copy Chapter

❤️ コントリビューション Copy Chapter

Issue や Pull Request は大歓迎です!このプロジェクトに変更を送信してください :)

コントリビュート方法 Copy Section

Issue を確認したり、PR(プルリクエスト)のレビューを手伝うことで貢献できます。どんな Issue や PR への参加も歓迎され、コミュニティ貢献を促進します。もちろん、これらは提案に過ぎず、どんな方法でも貢献できます。新機能の追加については、まず Issue で議論してください。

開発環境 Copy Section

AstrBot はコードのフォーマットとチェックに ruff を使用しています。

git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install

🌍 コミュニティ Copy Chapter

QQ グループ Copy Section

15 以上のチャットグループがあります。詳細はコミュニティをご覧ください。

Discord サーバー Copy Section

❤️ Special Thanks Copy Chapter

AstrBot への貢献をしていただいたすべてのコントリビューターとプラグイン開発者に特別な感謝を ❤️

オープンソースの仲間たち ❤️

• NapNeko/NapCatQQ - 素晴らしい猫フレームワーク
• Mai-with-u/MaiBot - QQ 上の強力な「デジタル生命」！

⭐ Star History Copy Chapter

[!TIP]
このプロジェクトがあなたの生活や仕事に役立ったり、このプロジェクトの今後の発展に関心がある場合は、プロジェクトに Star をください。これがこのオープンソースプロジェクトを維持する原動力です <3

File: README_ru.md Copy Chapter

Документация ｜
Блог ｜
Дорожная карта ｜
Сообщить о проблеме ｜
Email Support

AstrBot — это универсальная платформа Agent-чатботов с открытым исходным кодом, которая интегрируется с основными приложениями для обмена мгновенными сообщениями. Она предоставляет надёжную и масштабируемую инфраструктуру разговорного ИИ для частных лиц, разработчиков и команд. Будь то персональный ИИ-компаньон, интеллектуальная служба поддержки, автоматизированный помощник или корпоративная база знаний — AstrBot позволяет быстро создавать готовые к использованию ИИ-приложения в рабочих процессах вашей платформы обмена сообщениями.

Основные возможности Copy Chapter

1. 💯 Бесплатно & Открытый исходный код.
2. ✨ Диалоги с ИИ-моделями, мультимодальность, Agent, MCP, Skills, База знаний, Настройка личности, автоматическое сжатие диалогов.
3. 🤖 Поддержка интеграции с платформами Agents, такими как Dify, Alibaba Cloud Bailian, Coze и др.
4. 🌐 Мультиплатформенность: поддержка QQ, WeChat для предприятий, Feishu, DingTalk, публичных аккаунтов WeChat, Telegram, Slack и других.
5. 📦 Расширение плагинами: доступно более 1000 плагинов для установки в один клик.
6. 🛡️ Изолированная средаAgent Sandbox: безопасное выполнение любого кода, вызов Shell, повторное использование ресурсов на уровне сессии.
7. 💻 Поддержка WebUI.
8. 🌈 Поддержка Web ChatUI: встроенная песочница агента, веб-поиск и др.
9. 🌐 Поддержка интернационализации (i18n).

Быстрый старт Copy Chapter

Облачное развёртывание в один клик (RainYun) Copy Section

Пользователям, которые хотят развернуть AstrBot в один клик, обеспечить его круглосуточную работу и не управлять сервером самостоятельно, мы рекомендуем облачный сервис развёртывания в один клик от RainYun ☁️:

Развёртывание в один клик Copy Section

[!NOTE]
Требуется установленный uv.
Для пользователей macOS: из-за проверок безопасности macOS первый запуск команды astrbot может занять больше времени (около 10-20 секунд).

Для пользователей, которые хотят быстро попробовать AstrBot, знакомы с командной строкой и могут самостоятельно установить окружение uv, мы рекомендуем использовать развёртывание в один клик через uv ⚡️:

uv tool install astrbot --python 3.12
astrbot init # Выполните эту команду только при первом запуске для инициализации окружения
astrbot run

Обновить astrbot:

uv tool upgrade astrbot --python 3.12

Развёртывание Docker Copy Section

Для пользователей, знакомых с контейнерами и которым нужен более стабильный и подходящий для production способ, мы рекомендуем разворачивать AstrBot через Docker / Docker Compose.

См. официальную документацию Развёртывание AstrBot с Docker.

Развёртывание десктопного приложения Copy Section

Для пользователей, которые хотят использовать AstrBot на десктопе и в основном работают через ChatUI, мы рекомендуем AstrBot App.

Перейдите в AstrBot-desktop, скачайте и установите приложение; этот вариант предназначен для десктопа и не рекомендуется для серверных сценариев.

Развёртывание через лаунчер Copy Section

Также на десктопе, для пользователей, которым нужен быстрый запуск и мультиинстанс с изоляцией окружений, мы рекомендуем AstrBot Launcher.

Перейдите в AstrBot Launcher, чтобы скачать и установить.

Другие способы развёртывания

Если вам нужна панельная установка или более глубокая кастомизация, смотрите Развёртывание BT-Panel (установка через BT Panel), Развёртывание 1Panel (развёртывание через маркетплейс 1Panel), Развёртывание CasaOS (визуальный вариант для NAS и домашних серверов) и Ручное развёртывание (полностью настраиваемая установка из исходников через uv).

❤️ Спонсоры Copy Chapter

Вы можете поддержать нас через Afdian или связаться с нами по электронной почте.

Поддерживаемые платформы обмена сообщениями Copy Chapter

Подключите AstrBot к вашим любимым чат-платформам.

Поддерживаемые сервисы моделей Copy Chapter

❤️ Вклад в проект Copy Chapter

Issues и Pull Request всегда приветствуются! Не стесняйтесь отправлять свои изменения в этот проект :)

Как внести вклад Copy Section

Вы можете внести вклад, просматривая issues или помогая с ревью pull request. Любые issues или PR приветствуются для поощрения участия сообщества. Конечно, это лишь предложения — вы можете вносить вклад любым удобным для вас способом. Для добавления новых функций сначала обсудите это через Issue.

Среда разработки Copy Section

AstrBot использует ruff для форматирования и линтинга кода.

git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install

🌍 Сообщество Copy Chapter

Группы QQ Copy Section

У нас более 15 групп для общения; подробности см. на странице Сообщество.

Сервер Discord Copy Section

❤️ Особая благодарность Copy Chapter

Особая благодарность всем контрибьюторам и разработчикам плагинов за их вклад в AstrBot ❤️

Друзья из мира открытого исходного кода ❤️

• NapNeko/NapCatQQ - Замечательный кошачий фреймворк
• Mai-with-u/MaiBot - Мощная «цифровая жизнь» в QQ!

⭐ История звёзд Copy Chapter

[!TIP]
Если этот проект помог вам в жизни или работе, или если вас интересует его будущее развитие, пожалуйста, поставьте проекту звезду. Это движущая сила поддержки этого проекта с открытым исходным кодом <3

File: README_zh-TW.md Copy Chapter

文件 ｜
Blog ｜
路線圖 ｜
問題回報 ｜
Email

AstrBot 是一個開源的一站式 Agent 聊天機器人平台，可接入主流即時通訊軟體，為個人、開發者和團隊打造可靠、可擴展的對話式智慧基礎設施。無論是個人 AI 夥伴、智慧客服、自動化助手，還是企業知識庫，AstrBot 都能在您的即時通訊軟體平台的工作流程中快速構建生產可用的 AI 應用程式。

主要功能 Copy Chapter

1. 💯 免費 & 開源。
2. ✨ AI 大模型對話，多模態，Agent，MCP，Skills，知識庫，人格設定，自動壓縮對話。
3. 🤖 支援接入 Dify、阿里雲百煉、Coze 等智慧體 (Agent) 平台。
4. 🌐 多平台，支援 QQ、企業微信、飛書、釘釘、微信公眾號、Telegram、Slack 以及更多。
5. 📦 插件擴展，已有 1000+ 個插件可一鍵安裝。
6. 🛡️ Agent Sandbox 隔離化環境，安全地執行任何代碼、調用 Shell、會話級資源複用。
7. 💻 WebUI 支援。
8. 🌈 Web ChatUI 支援，ChatUI 內置代理沙盒 (Agent Sandbox)、網頁搜尋等。
9. 🌐 國際化（i18n）支援。

快速開始 Copy Chapter

雨雲一鍵雲端部署 Copy Section

對於希望一鍵部署並讓 AstrBot 24 小時在線、且不想自行管理伺服器的使用者，我們推薦使用雨雲的一鍵雲端部署服務 ☁️：

一鍵部署 Copy Section

[!NOTE]
需要安裝 uv。
對於 macOS 使用者：由於 macOS 安全性檢查，首次執行 astrbot 指令可能需要較長時間（約 10-20 秒）。

對於想快速體驗 AstrBot、且熟悉命令列並能自行安裝 uv 環境的使用者，我們推薦使用 uv 一鍵部署方式 ⚡️。

uv tool install astrbot --python 3.12
astrbot init # 僅首次執行此命令以初始化環境
astrbot run

更新 astrbot：

uv tool upgrade astrbot --python 3.12

Docker 部署 Copy Section

對於熟悉容器、希望獲得更穩定且更適合正式環境部署方式的使用者，我們推薦使用 Docker / Docker Compose 部署 AstrBot。

請參考官方文件 使用 Docker 部署 AstrBot。

桌面客戶端部署 Copy Section

對於希望在桌面端使用 AstrBot、並以 ChatUI 為主要入口的使用者，我們推薦使用 AstrBot App。

前往 AstrBot-desktop 下載並安裝；此方式面向桌面使用，不建議伺服器場景。

啟動器部署 Copy Section

同樣在桌面端，對於希望快速部署並實現環境隔離多開的使用者，我們推薦使用 AstrBot Launcher。

前往 AstrBot Launcher 下載並安裝。

更多部署方式

若你需要面板化或更高自訂程度的部署，可參考 寶塔面板（BT Panel 應用商店安裝）、1Panel（1Panel 應用商店安裝）、CasaOS（NAS / 家用伺服器可視化部署）與 手動部署（基於原始碼與 uv 的完整自訂安裝）。

❤️ 贊助商 Copy Chapter

歡迎透過 Afdian 或電子郵件聯絡我們贊助。

支援的訊息平台 Copy Chapter

將 AstrBot 連接到你常用的聊天平台。

支援的模型服務 Copy Chapter

❤️ 貢獻 Copy Chapter

歡迎任何 Issues/Pull Requests！只需要將您的變更提交到此專案 ：)

如何貢獻 Copy Section

您可以透過檢視問題或協助審核 PR（拉取請求）來貢獻。任何問題或 PR 都歡迎參與，以促進社群貢獻。當然，這些只是建議，您可以以任何方式進行貢獻。對於新功能的新增，請先透過 Issue 討論。

開發環境 Copy Section

AstrBot 使用 ruff 進行程式碼格式化和檢查。

git clone https://github.com/AstrBotDevs/AstrBot
pip install pre-commit
pre-commit install

🌍 社群 Copy Chapter

QQ 群組 Copy Section

我們有 15 個以上的交流群，詳情請參閱社群。

Discord 群組 Copy Section

❤️ Special Thanks Copy Chapter

特別感謝所有 Contributors 和外掛開發者對 AstrBot 的貢獻 ❤️

開源夥伴 ❤️

• NapNeko/NapCatQQ - 出色的貓貓框架
• Mai-with-u/MaiBot - QQ 中強大的「數位生命」！

⭐ Star History Copy Chapter

[!TIP]
如果本專案對您的生活 / 工作產生了幫助，或者您關注本專案的未來發展，請給專案 Star，這是我們維護這個開源專案的動力 <3