Skip to main content

​
Overview

Shannon provides a native desktop application built with Tauri for real-time task monitoring and management. The desktop app offers a streamlined interface for interacting with Shannon services.
The desktop application has replaced the previous web dashboard and provides improved performance and native OS integration.

​
Features

  • Live Task Streaming - Real-time SSE event feed for active tasks
  • Task Management - Submit, monitor, and cancel tasks
  • Session History - Browse and continue previous conversations
  • Multi-Platform - macOS (Universal), Windows, Linux, iOS

​
Swarm Radar Canvas

New in v0.3.0
The desktop app includes a Radar Canvas for visualizing multi-agent swarm execution in real time:
  • Lead Agent Pulse — The central node pulses to indicate Lead decision-making activity
  • Agent Color Coding — Each swarm agent is displayed with a distinct color based on its role and status (idle, running, completed)
  • Live Topology — Agent spawn, shutdown, and message flow are animated on the canvas as they happen

​
Supported Platforms

​
Installation

​
macOS

  1. Download the latest DMG from the Releases page
  2. Open the DMG file
  3. Drag Shannon to Applications folder
  4. Launch from Applications

​
Building from Source

1

Prerequisites

Ensure you have the required tools installed:
  • Node.js 18+
  • Rust 1.70+
  • Xcode Command Line Tools (macOS)
2

Clone and Install

3

Configure API Endpoint

4

Development Mode

5

Production Build

Output: src-tauri/target/release/bundle/dmg/shannon-desktop_0.3.0_universal.dmg

​
Configuration

​
API Endpoint

Set the Shannon API endpoint via environment variable:
For production deployments:

​
Usage

​
Main Interface

The desktop app provides:
  1. Chat Interface - Submit queries and view responses
  2. Runs View - Monitor active and completed tasks
  3. Run Details - View full event stream for a specific task
  4. Settings - Configure API endpoint and preferences

​
Submitting Tasks

  1. Open the app
  2. Enter your query in the chat input
  3. Press Enter or click Send
  4. Watch real-time events as the task executes

​
Monitoring Tasks

Navigate to the Runs page to see:
  • Active tasks with live status
  • Completed tasks with results
  • Failed tasks with error details
Click on any run to see the full event stream.

​
Troubleshooting

​
Build Fails: Module Not Found

​
Universal Binary Requirements (macOS)

Ensure both Rust targets are installed:

​
Connection Issues

  1. Verify Shannon services are running
  2. Check API URL in .env.local
  3. Ensure no firewall blocking port 8080

​
Clean Rebuild

​
Technology Stack

​
Next Steps

Installation

Set up Shannon services

Quick Start

Submit your first task

Streaming

Understand real-time events

API Reference

Full API documentation