Language
English 简体中文

Applications

This section collects the main entry points for using and starting Sage. Read this group first if you want to decide whether to enter through the CLI, the demo app, the main server, or the desktop build.

Current Pages

  1. Getting Started — first clone, dev-up.sh, shared config
  2. Web Application — Vite + FastAPI, manual split start, Docker Compose
  3. Desktop — release installers, macOS/Windows first launch, build from source
  4. CLI Guide
  5. TUI Guide
  6. Chrome extension — load unpacked, connect to a local API

Which Surface Should You Use

CLI

Use sage run, sage chat, and sage doctor when you need the fastest development-oriented entry point for local testing, prompt iteration, and runtime diagnostics.

Terminal TUI

Use sage-terminal when you want a terminal-first interactive experience on top of the same local Sage runtime, especially for session resume, slash-command workflows, and transcript browsing.

Streamlit demo

Use examples/sage_demo.py when you want a lightweight demo UI without starting the full application server.

Main server + web UI

Use app/server/main.py with app/server/web/ when you need the primary multi-user application stack:

  • authentication
  • agent management
  • tool and skill administration
  • knowledge base integration
  • observability endpoints
  • browser-based chat experience

Desktop app

Use app/desktop/entry.py and the desktop source tree when you need a packaged local application with a desktop-local backend and UI shell.

Web Application Structure

  • app/server/main.py: FastAPI app creation and startup
  • app/server/routers/: HTTP route groups
  • app/server/services/: application service layer
  • app/server/web/src/: Vue application source

The web client contains views for agents, chat, knowledge bases, tools, skills, versions, model providers, and system settings.

Desktop Application Structure

  • app/desktop/entry.py: bootstrap and path setup
  • app/desktop/core/main.py: desktop-local FastAPI service
  • app/desktop/ui/: frontend UI source
  • app/desktop/scripts/: build and development scripts

The desktop backend binds to 127.0.0.1 and is intended for local packaged execution.

Shared Platform Behavior

The server and desktop app both wrap Sage runtime capabilities behind FastAPI applications. They share the same broad platform concepts:

  • session-based execution
  • agent and tool management
  • streaming responses
  • skill and MCP integration
  • persistent configuration and storage

Table of contents

Sage documentation for the current repository layout. Source available under the MIT license.

This site uses Just the Docs, a documentation theme for Jekyll.