Skip to content

Latest commit

 

History

History
182 lines (119 loc) · 9.94 KB

README_en.md

File metadata and controls

182 lines (119 loc) · 9.94 KB

6e1279651f16d7fdf4727558b72bbaf1

✨ Easy-to-use Multi-platform LLM Chatbot & Development Framework ✨

Soulter%2FAstrBot | Trendshift

GitHub release (latest by date) python Docker pull Static Badge wakatime Dynamic JSON Badge codecov

DocumentationIssue Tracking

AstrBot is a loosely coupled, asynchronous chatbot and development framework that supports multi-platform deployment, featuring an easy-to-use plugin system and comprehensive Large Language Model (LLM) integration capabilities.

✨ Key Features

  1. LLM Conversations - Supports various LLMs including OpenAI API, Google Gemini, Llama, Deepseek, ChatGLM, etc. Enables local model deployment via Ollama/LLMTuner. Features multi-turn dialogues, personality contexts, multimodal capabilities (image understanding), and speech-to-text (Whisper).
  2. Multi-platform Integration - Supports QQ (OneBot), QQ Channels, WeChat (Gewechat), Feishu, and Telegram. Planned support for DingTalk, Discord, WhatsApp, and Xiaomi Smart Speakers. Includes rate limiting, whitelisting, keyword filtering, and Baidu content moderation.
  3. Agent Capabilities - Native support for code execution, natural language TODO lists, web search. Integrates with Dify Platform for easy access to Dify assistants/knowledge bases/workflows.
  4. Plugin System - Optimized plugin mechanism with minimal development effort. Supports multiple installed plugins.
  5. Web Dashboard - Visual configuration management, plugin controls, logging, and WebChat interface for direct LLM interaction.
  6. High Stability & Modularity - Event bus and pipeline architecture ensures high modularization and loose coupling.

Tip

Dashboard Demo: https://demo.astrbot.app/
Username: astrbot, Password: astrbot (LLM not configured for chat page)

✨ Deployment

Docker Deployment

See docs: Deploy with Docker

Windows Installer

Requires Python (>3.10). See docs: Windows Installer Guide

Replit Deployment

Run on Repl.it

CasaOS Deployment

Community-contributed method.
See docs: CasaOS Deployment

Manual Deployment

See docs: Source Code Deployment

⚡ Platform Support

Platform Status Details Message Types
QQ (Official Bot) Private/Group chats Text, Images
QQ (OneBot) Private/Group chats Text, Images, Voice
WeChat (Personal) Private/Group chats Text, Images, Voice
Telegram Private/Group chats Text, Images
WeChat Work Private chats Text, Images, Voice
Feishu Group chats Text, Images
WeChat Open Platform 🚧 Planned -
Discord 🚧 Planned -
WhatsApp 🚧 Planned -
Xiaomi Speakers 🚧 Planned -

Provider Support Status

Name Support Type Notes
OpenAI API Text Generation Supports all OpenAI API-compatible services including DeepSeek, Google Gemini, GLM, Moonshot, Alibaba Cloud Bailian, Silicon Flow, xAI, etc.
Claude API Text Generation
Google Gemini API Text Generation
Dify LLMOps
DashScope (Alibaba Cloud) LLMOps
Ollama Model Loader Local deployment for open-source LLMs (DeepSeek, Llama, etc.)
LM Studio Model Loader Local deployment for open-source LLMs (DeepSeek, Llama, etc.)
LLMTuner Model Loader Local loading of fine-tuned models (e.g. LoRA)
OneAPI LLM Distribution
Whisper Speech-to-Text Supports API and local deployment
SenseVoice Speech-to-Text Local deployment
OpenAI TTS API Text-to-Speech
Fishaudio Text-to-Speech Project involving GPT-Sovits author

🦌 Roadmap

Tip

Suggestions welcome via Issues <3

  • Ensure feature parity across all platform adapters
  • Optimize plugin APIs
  • Add default TTS services (e.g., GPT-Sovits)
  • Enhance chat features with persistent memory
  • i18n Planning

❤️ Contributions

All Issues/PRs welcome! Simply submit your changes to this project :)

For major features, please discuss via Issues first.

🌟 Support

✨ Demos

Note

Code executor file I/O currently tested with Napcat(QQ)/Lagrange(QQ)

✨ Docker-based Sandboxed Code Executor (Beta) ✨

✨ Multimodal Input, Web Search, Text-to-Image ✨

✨ Natural Language TODO Lists ✨

✨ Plugin System Showcase ✨

✨ Web Dashboard ✨

webchat

✨ Built-in Web Chat Interface ✨

⭐ Star History

Tip

If this project helps you, please give it a star <3

Star History Chart

Disclaimer

  1. Licensed under AGPL-v3.
  2. WeChat integration uses Gewechat. Use at your own risk with non-critical accounts.
  3. Users must comply with local laws and regulations.

私は、高性能ですから!