Skip to content

Latest commit

ย 

History

History
executable file
ยท
316 lines (227 loc) ยท 11.9 KB

File metadata and controls

executable file
ยท
316 lines (227 loc) ยท 11.9 KB

๐ŸŒŸ Experience Sage's Power

cover

English ็ฎ€ไฝ“ไธญๆ–‡ License: MIT Python 3.10+ Version DeepWiki Slack

๐Ÿง  Sage Agent Platform

๐ŸŽฏ From Complex Work to Reliable Delivery

๐ŸŒŸ A production-ready agent platform for task execution, automation, browser workflows, IM delivery, and enterprise deployment.


๐Ÿ“ธ Product Screenshots

Workbench
Visual Workbench
Chat
Real-time Collaboration
Preview
Multi-format Support

๐Ÿ“– Detailed Documentation: https://wiki.sage.zavixai.com/


โœจ Key Features

  • ๐Ÿค– Planning to Delivery: Built-in planning, execution, self-check, memory recall, and tool suggestion agents for complex task completion.
  • ๐ŸŒ Multi-Entry Product Surface: Use Sage from desktop, web, CLI, and Chrome extension depending on the workflow.
  • ๐Ÿ” Automation & Recurring Tasks: Run scheduled jobs, questionnaire-driven collection flows, and long-running operational tasks with progress visibility.
  • ๐Ÿ’ฌ Omnichannel IM Integration: Connect WeChat Personal (iLink), WeCom, Feishu, and DingTalk with message and file delivery support.
  • ๐Ÿงฐ Unified Tooling System: Combine built-in tools, Skills, MCP servers, browser automation, search, and image generation in one execution stack.
  • ๐Ÿ›ก๏ธ Sandboxed Execution: Local, passthrough, and remote sandbox options for safer agent runtime isolation.
  • ๐Ÿ› ๏ธ Visual Workbench: Inspect files, tool outputs, code, charts, Mermaid, Draw.io, audio, video, and remote previews in one workspace.
  • ๐Ÿข Enterprise-Ready Foundation: OAuth2, configurable auth and CORS, shared service architecture, CI coverage, and deployable multi-platform packaging.

๐Ÿš€ Quick Start

Prerequisites (web from source): Python 3.10+, Node.js 18+.

Web (clone and run)

git clone https://github.com/ZHangZHengEric/Sage.git
cd Sage
export SAGE_DEFAULT_LLM_API_KEY="your-api-key"
export SAGE_DEFAULT_LLM_API_BASE_URL="https://api.deepseek.com/v1"
export SAGE_DEFAULT_LLM_MODEL_NAME="deepseek-chat"
./scripts/dev-up.sh

Open http://localhost:5173. The first run may ask for Minimal (SQLite) vs Full stacks โ€” Minimal is the quickest. Optional: PYTHON_BIN=... or USE_UV=1 ./scripts/dev-up.sh if you use a custom Python or uv.

Detailed documentation: Web Application โ€” manual backend + Vite, Docker Compose, and port notes.

Desktop (installers)

Download the latest .dmg (macOS), .exe NSIS installer (Windows), or .deb (Linux) from GitHub Releases, then install as below.

macOS

  1. Open the .dmg for your CPU (Intel or Apple Silicon), drag Sage.app into Applications.
  2. The build is not currently Apple-notarized. If macOS says the developer cannot be verified or the app cannot be checked for malware: in Finder โ†’ Applications, rightโ€‘click Sage.app โ†’ Open, then confirm Open in the dialog (this adds a one-time exception for Gatekeeper).
  3. If it is still blocked: System Settings โ†’ Privacy & Security, scroll to the message about Sage, click Open Anyway, then try opening the app again.
  4. If macOS reports the app is damaged or will not open, clear the quarantine flag and retry:
xattr -dr com.apple.quarantine /Applications/Sage.app

Windows

  1. Run the .exe installer and complete the wizard.
  2. If Windows SmartScreen warns about an unknown publisher, click More info โ†’ Run anyway (wording may vary by Windows version).

Linux (Debian / Ubuntu)

  1. Download the .deb for your architecture from Releases.
  2. Install from a terminal (adjust the filename):
sudo apt install ./Sage-<version>-<arch>.deb

You can also double-click the .deb in many desktop environments.

Detailed documentation: Desktop Application โ€” build from source, env, and platform notes.

CLI

pip install -e .
export SAGE_DEFAULT_LLM_API_KEY="your-api-key"
export SAGE_DEFAULT_LLM_API_BASE_URL="https://api.deepseek.com/v1"
export SAGE_DEFAULT_LLM_MODEL_NAME="deepseek-chat"
export SAGE_DB_TYPE="file"
sage doctor
sage run "Say hello briefly."
# or: sage chat

Detailed documentation: CLI Guide

TUI

After pip install -e . and the same SAGE_DEFAULT_* + SAGE_DB_TYPE=file as above, use sage-terminal (or run from app/terminal/ with cargo โ€” see the guide).

Detailed documentation: TUI Guide

Chrome extension

Load the unpacked extension from app/chrome-extension/ in chrome://extensions/ (Developer mode). Point the extension at your local Sage backend if the port differs from defaults.

Detailed documentation: Chrome extension


๐Ÿ—๏ธ System Architecture

graph TD
    User[User] --> Desktop[๐Ÿ’ป Desktop App]
    User --> Web[๐ŸŒ Web App]
    User --> CLI[โŒจ๏ธ CLI]
    User --> Ext[๐Ÿงฉ Chrome Extension]
    User --> IM[๐Ÿ’ฌ IM Channels]

    Desktop --> AppLayer[๐Ÿงญ App Service Layer]
    Web --> AppLayer
    CLI --> AppLayer
    Ext --> AppLayer
    IM --> AppLayer

    subgraph App[Product Layer]
        AppLayer --> Chat[๐Ÿ’ฌ Chat & Sessions]
        AppLayer --> AgentsUI[๐Ÿค– Agent Management]
        AppLayer --> Tasks[โฐ Tasks & Automations]
        AppLayer --> Browser[๐ŸŒ Browser Bridge]
        AppLayer --> Workbench[๐Ÿ› ๏ธ Visual Workbench]
    end

    subgraph Core[SAgents Core]
        AppLayer --> Runtime[๐Ÿง  Session Runtime]
        Runtime --> Flow[๐Ÿ“‹ AgentFlow]
        Flow --> Agents["๐Ÿค– Agents<br/>Plan / Simple / Fibre / Self-Check"]
        Agents --> Memory[๐Ÿง  Memory Recall]
        Agents --> Skills[๐Ÿงฉ Skills]
        Agents --> ToolMgr[๐Ÿ› ๏ธ Tool Manager]
    end

    subgraph Tools[Execution & Integration]
        ToolMgr --> MCP[๐Ÿ”Œ MCP Servers]
        ToolMgr --> BrowserTools[๐ŸŒ Browser Automation]
        ToolMgr --> Search[๐Ÿ”Ž Unified Search]
        ToolMgr --> ImageGen[๐ŸŽจ Image Generation]
        ToolMgr --> Questionnaire[๐Ÿ“ Questionnaire]
        ToolMgr --> IMTools[๐Ÿ“จ IM Delivery]
    end

    subgraph RuntimeEnv[Runtime & Infrastructure]
        Agents --> Sandbox[๐Ÿ“ฆ Sandbox Runtime]
        Sandbox --> Local[Local]
        Sandbox --> Pass[Passthrough]
        Sandbox --> Remote[Remote]
        AppLayer <--> Common[๐Ÿงฑ Shared Common Services]
        Common <--> DB[(SQL Database)]
        Memory <--> ES[(Elasticsearch)]
        Workbench <--> FS[(RustFS / Local Files)]
        Runtime -.-> Obs["๐Ÿ‘๏ธ Observability<br/>OpenTelemetry"]
    end
Loading

๐Ÿ“… What's New in v1.1.0

๐Ÿค– SAgents Kernel Updates

  • Execution Chain Enhancements: Added PlanAgent, SelfCheckAgent, MemoryRecallAgent, and ToolSuggestionAgent
  • Context Efficiency: Improved user input optimization and conversation history compression for long-running tasks
  • Session & Messaging: Added edit-and-rerun support, richer progress feedback, and better session inspection workflows
  • Tooling Expansion: Added questionnaire collection workflows and improved tool-call rendering, truncation, and observability

๐Ÿ’ป Product Layer Updates

  • New Entry Points: Added Sage CLI, Chrome extension, and browser automation tooling
  • Workbench Upgrades: Expanded support for audio, video, Mermaid, Draw.io, remote file preview, and richer tool cards
  • Chat Experience: Improved progress messages, delivery flow display, reasoning content presentation, and workspace interactions
  • IM Integrations: Expanded WeChat Personal (iLink), WeCom, Feishu, and DingTalk support with stronger file messaging flows

๐Ÿ›ก๏ธ Platform & Infrastructure

  • Enterprise Readiness: Added OAuth2, email verification, and stronger auth/CORS/security controls
  • Sandbox & Runtime: Refactored local/passthrough/remote sandbox support and improved Node runtime/sidecar packaging
  • Shared Architecture: Extracted reusable common/ services, models, and schemas across desktop and server
  • Documentation & CI: Rebuilt the docs structure, added CLI guides, and expanded CI/test coverage

View Full Release Notes


๐Ÿ“š Documentation

  • ๐Ÿ“– Full Documentation: https://wiki.sage.zavixai.com/
  • ๐Ÿ“ Release Notes: release_notes/
  • ๐Ÿ—๏ธ Architecture: See sagents/, common/, and app/ for the core runtime and product layers
  • ๐Ÿ”ง Configuration: Environment variables and config files in app/desktop/

๐Ÿ› ๏ธ Development

Project Structure

Sage/
โ”œโ”€โ”€ sagents/                    # SAgents core runtime, flow, context, tools, sandbox
โ”œโ”€โ”€ common/                     # Shared models, schemas, services, core clients
โ”œโ”€โ”€ app/
โ”‚   โ”œโ”€โ”€ desktop/                # Desktop app (Python backend + Vue UI + Tauri shell)
โ”‚   โ”œโ”€โ”€ server/                 # Server app and web frontend
โ”‚   โ”œโ”€โ”€ cli/                    # Sage CLI entrypoint and services
โ”‚   โ””โ”€โ”€ chrome-extension/       # Browser extension and sidepanel
โ”œโ”€โ”€ mcp_servers/                # IM, search, scheduler, image generation and more
โ”œโ”€โ”€ docs/                       # English and Chinese documentation
โ””โ”€โ”€ release_notes/              # Version release notes

Contributing

We welcome contributions! Please see our GitHub Issues for tasks and discussions.


๐Ÿ’– Sponsors

We are grateful to our sponsors for their support in making Sage better:

Dudu Bus
RcrAI Data

๐ŸฆŒ Join Our Community

๐Ÿ’ฌ Connect with us

Slack

๐Ÿ“ฑ WeChat Group

WeChat Group QR Code

Scan to join our WeChat community ๐ŸฆŒ


Built with โค๏ธ by the Sage Team ๐ŸฆŒ