
#### #### ## Introduction ### 🚀 **An AI desktop companion with endless possibilities!** #### Desktop Companion: Supports custom VRM models, actions, 3D scenes, and is compatible with [live2D extensions](https://github.com/heshengtao/sap-live2d)  #### Link VTS: Control Live2D models in Vtube Studio, supporting custom actions and expression control  #### High-freedom chat interface: custom background images, emoji packs, character personas, THA-based 2D character avatars, and character MCP tools for a more immersive conversation  #### Task Center: Enable your AI agents to perform any advanced tasks in the background, automatically control your computer to get work done, supporting MCP and Agent Skills.  #### Computer Control: Through desktop vision combined with a toolchain for controlling the mouse, keyboard, and terminal, AI agents can accomplish any task on a computer! The image below shows an AI playing Wordle.  #### Multiple Window Modes: The chat interface supports phone-sized and capsule-sized docking on the desktop  #### Multi-Role Group Chat: Supports tavern character cards and long-term memory, allowing you to chat with multiple characters simultaneously!  #### Instant Messaging Bot: Supports one-click deployment to QQ, WeChat, Feishu, DingTalk, Telegram, Discord, Slack  #### Live Streaming Bot: Supports one-click deployment to Bilibili, YouTube, Twitch, and enables 360-degree panoramic live streaming.  #### AI Browser: Equips your AI agents with their own browser, supporting automatic control  #### Extension System: Supports installing extensions and creating new ones. The image below shows a galgame extension. All extensions can be opened either in an independent window or in a sidebar.You can even use the agent skill [sap-extension-creator](skills/sap-extension-creator) to create new SAP extensions, achieving the bootstrapping of the agent party!  #### Developer-Friendly: Offers open OpenAI API interfaces and MCP interfaces, allowing agents to be externally connected  ## Quick Start ### 中国用户下载请点击 **中国用户点击下载** 的链接! ### If you are a CLI Agent CLI Agent needs to check the documentation at [README_AGENT.md](https://raw.githubusercontent.com/heshengtao/super-agent-party/main/README_AGENT.md). Please refer to this document to guide users through installing this software! ### If you are a human using a CLI Agent Send this link to your AI, and the AI will guide you through installing this software! ``` curl -fsSL https://raw.githubusercontent.com/heshengtao/super-agent-party/main/README_AGENT.md ``` ### Windows portable package (Recommended! Installation-free source version, support one-click synchronization to the latest version of the warehouse, no need to wait for the desktop version to be packaged) 👉 [Click to download](https://github.com/heshengtao/super-agent-party/releases/download/v0.4.2/super-agent-party-win-v0.4.2.zip) 👉 [中国用户点击下载](https://modelscope.cn/models/ailm32442/super-agent-party-portable/resolve/master/v0.4.2/super-agent-party-win-v0.4.2.zip) ⭐ Note! You can double-click `一键更新(update).bat` to update the software, or you can double-click `一键启动(start).bat` to start the software.The operating system must be **Windows 10/11, Windows Server 2025**, or a later version! ### Windows Desktop Installation 👉 [Click to download](https://github.com/heshengtao/super-agent-party/releases/download/v0.4.2/Super-Agent-Party-Setup-0.4.2.exe) 👉 [中国用户点击下载](https://modelscope.cn/models/ailm32442/super-agent-party-portable/resolve/master/v0.4.2/Super-Agent-Party-Setup-0.4.2.exe) ⭐ Note! Choose to install only for the current user during installation, otherwise, administrator privileges will be required to start.The operating system must be **Windows 10/11, Windows Server 2025**, or a later version! ### MacOS Integrated Package (Currently only supports M chips, no-install source code version, supports one-click sync to the latest repository version, no need to wait for desktop version packaging) > **Suitable for developers/advanced users**: No-install source code version, supports one-click sync to the latest repository version, no need to wait for desktop version packaging. 👉 [International users click to download](https://github.com/heshengtao/super-agent-party/releases/download/v0.4.2/super-agent-party-mac-v0.4.2.zip) 👉 [中国用户点击下载](https://modelscope.cn/models/ailm32442/super-agent-party-portable/resolve/master/v0.4.2/super-agent-party-mac-v0.4.2.zip) #### 🚀 Usage Steps **1. Remove Network Download Quarantine (Important)** After downloading and extracting, open Terminal, enter the following command (note there is a space at the end), then drag the **extracted folder** into the Terminal window and press Enter: ```shell sudo xattr -rd com.apple.quarantine ``` *(Note: The `-rd` parameter recursively removes the quarantine attributes for all components within the folder; otherwise, the Python environment may not function properly.)* **2. Grant Script Execution Permissions** Navigate to the folder in Terminal and execute: ```shell chmod +x 一键更新(update).sh 一键启动(start).sh ``` **3. Run the Software** - **First use/Update:** It is recommended to first execute `./一键更新(update).sh` to ensure dependencies are synced to the latest. - **Daily startup:** Directly execute `./一键启动(start).sh`. ### MacOS Desktop Installation (Currently only M chips are supported.) 👉 [Click to download](https://github.com/heshengtao/super-agent-party/releases/download/v0.4.2/Super-Agent-Party-0.4.2-Mac.dmg) 👉 [中国用户点击下载](https://modelscope.cn/models/ailm32442/super-agent-party-portable/resolve/master/v0.4.2/Super-Agent-Party-0.4.2-Mac.dmg) ⭐Attention! After downloading, drag the app file of the dmg file into the `/Applications` directory, then open end point, execute the following command and enter the root password to remove the attached Quarantine attribute from the network download: ```shell sudo xattr -dr com.apple.quarantine /Applications/Super-Agent-Party.app ``` ### Linux Desktop Installation `.AppImage` is a Linux application format that does not require installation and can be used immediately. Suitable for most Linux distributions. 👉 [Linux-AppImage-X86_64](https://github.com/heshengtao/super-agent-party/releases/download/v0.4.2/Super-Agent-Party-0.4.2-Linux-x86_64.AppImage) 👉 [Linux-AppImage-Arm64](https://github.com/heshengtao/super-agent-party/releases/download/v0.4.2/Super-Agent-Party-0.4.2-Linux-arm64.AppImage) ### Docker Deployment (This version of the desktop pet can only be viewed through a browser) #### International Users (Docker Hub) ```shell docker pull ailm32442/super-agent-party:latest docker run -d -p 3456:3456 -v ./super-agent-data:/app/data ailm32442/super-agent-party:latest ``` #### Chinese Users (Alibaba Cloud ACR, faster pull) ```shell docker pull crpi-9mgnqijkd7wc42x2.cn-shenzhen.personal.cr.aliyuncs.com/ailm32442/super-agent-party:latest docker run -d -p 3456:3456 -v ./super-agent-data:/app/data crpi-9mgnqijkd7wc42x2.cn-shenzhen.personal.cr.aliyuncs.com/ailm32442/super-agent-party:latest ``` ⭐ Note! `./super-agent-data` can be replaced with any local folder. After Docker starts, all data will be cached in this local folder and will not be uploaded anywhere. **Out of the box:** Visit http://localhost:3456/ --- ### Docker Compose Deployment (This version of the desktop pet can only be viewed through a browser, and an additional gateway container will be started for login management) #### International Users (Docker Hub) ```shell git clone https://github.com/heshengtao/super-agent-party.git cd super-agent-party docker-compose up -d ``` #### Chinese Users (Alibaba Cloud ACR, faster pull) ```shell git clone https://github.com/heshengtao/super-agent-party.git cd super-agent-party docker-compose -f docker-compose-acr.yml up -d ``` ⭐ Note! The default username is `root`, and the default password is `pass`. Please change the password after the first login. **Out of the box:** Visit http://localhost:3456/ **API key management:** Visit http://localhost:3456/token.html ### Lite client that matches your Docker version, turning Docker into a desktop app 👉 [SAP-lite-Windows-exe](https://github.com/heshengtao/desktop-for-sap/releases/download/v0.1.2/super-agent-party-lite-Setup-0.1.2.exe) 👉 [SAP-lite-MacOS-dmg](https://github.com/heshengtao/desktop-for-sap/releases/download/v0.1.2/super-agent-party-lite-0.1.2-Mac.dmg) ### Source Code Deployment ```shell git clone https://github.com/heshengtao/super-agent-party.git cd super-agent-party uv sync npm install npm run dev ``` ## Extension Added a brand-new extension system. You can check available plugins at [plugins list](https://super-agent-party.github.io/plugins.html), or directly view and install them in the party under 【Developer】->【Extensions】. You can also add your own developed extensions to the official plugin list at [super-agent-party.github.io](https://github.com/super-agent-party/super-agent-party.github.io)! ### Existing Extension | Name | Author | Description | Repository URL | |-----------------------|-------------------|--------------------------------------------------------------------|--------------------------------------------------| | Super Agent Party Example | heshengtao | Example plugin for Super Agent Party, demonstrating plugin architecture and capabilities. | https://github.com/heshengtao/sap-example | | Super Agent Party Example With NodeJS | heshengtao | This is a chat frontend example with nodeJS environment | https://github.com/heshengtao/sap-example-with-node | | Web Preview | heshengtao | A plugin enabling web previewing functionality for Super Agent Party. | https://github.com/heshengtao/sap-web-preview | | Story Adventure | heshengtao | An interactive story adventure plugin that generates story content and options using AI. | https://github.com/heshengtao/sap-story-adventure | | Live 2D | heshengtao | This is a Live 2D extension | https://github.com/heshengtao/sap-live2d | | AI Editor | heshengtao | This is an AI Editor | https://github.com/heshengtao/sap-aieditor | | AI galgame | heshengtao | This is an AI galgame extension | https://github.com/heshengtao/sap-aigalgame | | AI tarot reader | heshengtao | This is an AI tarot reader extension | https://github.com/heshengtao/sap-tarot | | AI sheet | heshengtao | This is an AI Sheet extension | https://github.com/heshengtao/sap-ai-sheet | | AI drawio | heshengtao | This is an AI drawio extension | https://github.com/heshengtao/sap-ai-drawio | | AI mermaid | heshengtao | This is an AI mermaid editor extension | https://github.com/heshengtao/sap-ai-mermaid | | AI RSS reader | heshengtao | This is an AI RSS reader extension for the Super Agent Party | https://github.com/heshengtao/sap-rss | | Remote | heshengtao | One-click expose Super Agent Party to the public internet | https://github.com/heshengtao/sap-remote | | Code Server | heshengtao | IDE extension for Super Agent Party | https://github.com/heshengtao/sap-code-server | | CLI | heshengtao | CLI extension for Super Agent Party | https://github.com/heshengtao/sap-cli | | LX-music | heshengtao | Connect super agent party to LX Music API, let AI companion control music playback! | https://github.com/heshengtao/sap-lx-music | | AI PPT | heshengtao | AI PPT extension for Super Agent Party | https://github.com/heshengtao/sap-ai-ppt | | Lyra 星莱 | heshengtao | Starlight mage character extension — one-click installs character card, THA model, stickers & background | https://github.com/heshengtao/sap-lyra-extension | ## Hardware requirements - CPU: 2 cores or more - Memory: 2GB or more **Because all models are optional, you can access the local deployment engine, or you can all use the Cloud as a Service provider interface, so there are few hardware requirements. Test the docker version on the 2-core 2G Cloud as a Service server and it will work fine** ## Usage - Desktop: Click the desktop icon to use immediately. - Web or docker: Access http://localhost:3456/ after startup. - API call: Developer-friendly, perfectly compatible with OpenAI format, can output in real-time, and does not affect the original API's response speed. No need to modify the calling code: ```python from openai import OpenAI client = OpenAI( api_key="super-secret-key", base_url="http://localhost:3456/v1" ) response = client.chat.completions.create( model="super-model", messages=[ {"role": "user", "content": "What is Super Agent Party?"} ] ) print(response.choices[0].message.content) ``` - MCP call: After starting, you can invoke the local MCP service by writing the following content in the configuration file: ```json { "mcpServers": { "super-agent-party": { "url": "http://127.0.0.1:3456/mcp", } } } ``` - Shortcut commands: In the chat box or any connected IM platform (Feishu, QQ, Telegram, Discord, Slack, WeChat, WeCom, DingTalk), type the commands below to quickly control the assistant. You can toggle them and view the full list in **System Settings → Shortcut Commands**. | Command | Aliases | Scope | Description | | --- | --- | --- | --- | | `/help` | `/帮助` `/?` | Chat + IM | List all available shortcut commands | | `/new` | `/reset` `/重启` `/新建` `/restart` | Chat + IM | Clear the current conversation and start fresh | | `/stop` | `/停止` | Chat + IM | Stop the response currently being generated | | `/retry` | `/重试` | Chat only | Regenerate the last reply | | `/model [provider:model]` | `/模型` | Chat + IM | Show or switch the model (IM shows only) | | `/personality [name]` | `/角色` `/persona` | Chat + IM | Show or switch the personality | | `/skills` | `/技能` | Chat + IM | Browse the list of available skills | | `/id` | - | IM only | Show the current session/channel ChatID | | `/sub` | `/订阅` | IM only | Add the current session to the proactive message list | | `/unsub` | `/取消订阅` | IM only | Remove the current session from the proactive message list | | `/plan` * | `/计划` | Chat + IM | Switch to plan mode (read-only) | | `/read` * | `/只读` | Chat + IM | Switch to read-only mode (confirm each action) | | `/edit` * | `/编辑` | Chat + IM | Switch to accept-edits mode | | `/yolo` * | - | Chat + IM | Switch to Yolo mode (full autonomy) | | `/cowork` * | `/协作` | Chat + IM | Switch to cowork mode (sub-agent collaboration) | | `/goal` * | `/目标` | Chat + IM | Switch to goal mode (autonomous loop) | | `/