DOCSEARCHbyAlgolia
Submit Docs

AionUi

repository·main·Indexed 11 days ago

https://github.com/iofficeai/aionui

An open-source 'Cowork' platform that transforms command-line AI agents into a modern AI Chat interface. Version 2.1.53 supports a unified interface for managing built-in and external CLI-based agents, featuring a multi-agent 'Team Mode', session management, and remote connection channels for platforms like Telegram, Lark, DingTalk, WeChat, and WeCom.

Tokens
108.7K
Snippets
177
Records
486
Agent score
98%

What's inside AionUi

  1. Overview of WebUI Remote Connection Features

    main

    The WebUI service provides a remote interface for managing and interacting with the system. Key capabilities include:

    • Service Management: Start and stop the WebUI service, including startup recovery and configuration persistence.
    • Access & Security: Display of access addresses, remote access control, username management, password visibility/initialization, and password modification.
    • Authentication: Support for QR code login.
    • Interface Structure: A dual-tab layout consisting of a WebUI tab and a Channels tab.
    • Real-time Synchronization: Real-time status synchronization across the interface.
    • Extensibility: A backend system that allows for contributing to the WebUI via the extension system.

  2. What is AionUi (Cowork)

    main

    AionUi is an open-source platform for Coworking with AI agents. Unlike traditional AI chat clients, AionUi allows agents to work directly on your local machine by reading/writing files, performing web searches, and executing multi-step autonomous tasks with your confirmation.

    Key capabilities include:

    • File Access: Built-in agents with full file system access.
    • Autonomy: Agents can execute multiple steps autonomously.
    • Remote Access: Accessible via WebUI and messaging platforms like Telegram, Lark, DingTalk, WeChat, and more.
    • Scheduled Automation: Supports Cron for 24/7 unattended automation.
    • Multi-Agent Support: A single interface to manage dozens of external agents (e.g., Claude Code, Codex, Qwen Code, Hermes Agent, Cursor Agent).
    • Open Source: Free to use and fully open-source.

  3. Overview of AionUi Cowork Platform

    main
    AionUi is an open-source Cowork platform designed for working alongside AI agents. Unlike traditional chat clients, AionUi allows agents to operate directly on your local files, execute multi-step autonomous tasks (with user approval), and provides remote access via WebUI, Telegram, Lark, DingTalk, and WeChat. It supports scheduled automation via Cron and can manage dozens of external CLI agents (like Claude Code, Codex, and Cursor Agent) within a single unified interface.

  4. Overview of Custom Agent Configuration and Testing

    main
    The Custom Agent feature allows users to configure, manage, and test external AI agents within the AionUI ecosystem. This includes creating new agents, editing their properties (such as name, commands, parameters, and environment variables), and performing connection tests to ensure they are operational. The system also supports automatic detection of agents and provides a dedicated interface for managing both detected and custom-defined agents.

  5. Overview of Settings → About & Update functionality

    main

    The Settings → About page in AionUI manages application information, update checks, and user feedback. It is composed of 12 distinct functional points (F-ABOUT-01 to F-ABOUT-12) covering application metadata, update mechanisms (automatic and manual), pre-release version toggles, and external navigation/reporting.

    Key Functional Areas

    • Application Info & Navigation: Displays app info and provides external links and issue reporting.
    • Update Management: Includes update check entry points, pre-release version toggles, and dual-path update checking.
    • Download & Installation: Handles automatic downloads, manual downloads, and error recovery during the update process.
    • UI State Management: Manages the update popup state machine and various trigger methods for automatic checks.

  6. Overview of Remote Connection Channels

    main

    The Channels feature in the AionUI settings page allows users to connect and configure various communication platforms to act as interfaces for AI agents. This enables multi-channel access to agent capabilities through services like Telegram, Lark/Feishu, DingTalk, WeChat, and WeCom.

    Key capabilities include:

    • Platform Configuration: Dedicated setup flows for major messaging apps.
    • Agent & Model Assignment: Selecting which specific Agent and default LLM model should be active for a given channel.
    • Authentication: Support for various auth methods including QR code login (WeChat) and WebSocket long connections (WeCom).
    • Extensibility: A framework for adding new custom channels.

  7. Overview of Channels in AionUi

    main

    The Channels tab in the 'Remote Connection' settings allows you to connect AionUi to various Instant Messaging (IM) platforms. This enables you to interact with your AI agents directly from apps like Telegram, Slack, and Discord.

    Supported Channels

    ChannelpluginIdStatus
    Telegramtelegram_defaultactive
    Slackslack_defaultactive
    Discorddiscordactive
    Lark / Feishulark_defaultactive
    DingTalkdingtalk_defaultactive
    WeChatweixin_defaultactive
    WeComwecom_defaultactive
    ExtensionsDynamic (extensionMeta)active

    Key Features

    • Channel Cards: Each channel is presented as a collapsible card. You can enable/disable a channel using the Switch in the header without expanding the card.
    • Real-time Status: Connection status (e.g., Connected, Error, Connecting) is updated via the channel.pluginStatusChanged.on() event.
    • Pairing & Authorization: For most IM channels, users must send a message to the bot to trigger a pairing request. Administrators can then approve or reject these requests via the channel.pairingRequested.on event to add them to the Authorized Users list.

  8. Overview of the Preview Module

    main

    The Preview module is AionUi's file preview and editing system. It uses a multi-tab architecture that allows users to open multiple files simultaneously, each in its own tab.

    Key Capabilities:

    • Multi-Tab Management: Supports opening multiple files, smart tab reuse (preventing duplicate tabs for the same file), and context menus for closing tabs.
    • Extensive File Support: Includes viewers for Markdown, Code (syntax highlighting), Images, Diffs, PDFs, Office documents (Word, Excel, PPT), HTML, and more.
    • Advanced Editing: Features include split-screen mode with scroll synchronization, real-time streaming updates (auto-updating when an agent writes a file), and dirty detection for unsaved changes.
    • Keyboard Shortcuts: Supports Cmd/Ctrl + S to save and Cmd/Ctrl + W to close tabs.

  9. Overview of ACP Single-Chat Features

    main

    The ACP (Agentic Chat Platform) Single-Chat feature set provides a comprehensive suite of capabilities for interacting with AI agents. The functionality is organized into several core modules:

    • Session Management (session): Handles the lifecycle of a chat, including creating, entering, deleting, and migrating sessions, as well as managing connection stability and idle timeouts.
    • Messaging (messaging): Manages text communication, file attachments, AI rule injection, and specialized commands like /btw for context appending.
    • Configuration (config): Allows users to switch AI models, adjust session modes, tune AI parameters, and manage timeout settings.
    • Permissions (permissions): Controls AI operation approvals, including a 'YOLO mode' (免确认模式) for automated execution and viewing pending approval lists.
    • Display (display): Manages the UI/UX, including real-time streaming of AI responses, thought process visualization, tool call displays, and slash command lists.
    • Reliability (reliability): Ensures system stability through automatic handling of connection/response timeouts, local cache repair, and error recovery.
    • Skills (skills): Facilitates the discovery and injection of AI skills and MCP (Model Context Protocol) tool services.

  10. Navigate AionUi documentation

    main

    AionUi documentation is organized by reader intent. Use the following directory structure to find the information you need:

    • guides/: For users and operators. Contains instructions on how to deploy, test, and run the product (e.g., Server deployment, WebUI, Hub testing, CDP debugging).
    • architecture/: For engineers and architects. Contains system architecture overviews, subsystem deep-dives (ACP, queue, team mode), and research notes.
    • specs/: For engineering-driven specifications. Contains feature design docs, requirements, and implementation plans.
    • prds/: For the product team. Contains formal Product Requirement Documents.
    • readme/: For global users. Contains translated copies of the root README in various languages (Chinese, Japanese, Korean, Spanish, etc.).
    • contributing/: For contributors. Contains dev environment setup and workflow information.

  11. What is AionUi (Cowork Platform)

    main

    AionUi is an open-source Cowork platform designed for collaborating with AI Agents. Unlike traditional AI chat clients, AionUi allows agents to perform real-world tasks on your computer, such as reading/writing files, executing code, searching the web, and automating workflows.

    Key capabilities include:

    • File Access: Built-in agents can interact directly with your local file system.
    • Multi-step Autonomy: Agents can execute complex tasks autonomously (with user approval).
    • Remote Access: Access your agents via WebUI or messaging platforms like Telegram, Lark, DingTalk, and WeChat.
    • 24/7 Automation: Supports Cron jobs for unattended task execution.
    • Multi-Agent Support: Integrates with various CLI agents (e.g., Claude Code, Cursor Agent, Qwen Code) through a unified interface.
    • Team Mode: Enables coordinated multi-agent collaboration where a 'Leader' agent decomposes tasks and delegates them to 'Teammate' agents.

  12. What is AionUi WebUI Mode?

    main

    WebUI mode starts AionUi with an embedded web server, enabling access through a modern web browser. This mode is useful for:

    • Accessing the application via http://localhost:3000 (or the port specified in the application output).
    • Running the application headless on servers.
    • Accessing the application from remote devices on the same network by using the --remote flag.