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

​
Supported Platforms

PlatformArchitectureFormat
macOSUniversal (Intel + Apple Silicon)DMG
Windowsx86_64MSI
Linuxx86_64AppImage/DEB
iOSARM64App Bundle

​
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
# Or install via command line
open shannon-desktop_0.1.0_universal.dmg

​
Building from Source

1

Prerequisites

Ensure you have the required tools installed:
  • Node.js 18+
  • Rust 1.70+
  • Xcode Command Line Tools (macOS)
# Install Rust targets for universal binary (macOS)
rustup target add aarch64-apple-darwin x86_64-apple-darwin
2

Clone and Install

git clone https://github.com/Kocoro-lab/Shannon.git
cd Shannon/desktop
npm install
3

Configure API Endpoint

cp .env.local.example .env.local
# Edit .env.local to set your Shannon API URL
# Default: http://localhost:8080
4

Development Mode

npm run tauri:dev
5

Production Build

npm run tauri:build
Output: src-tauri/target/release/bundle/dmg/shannon-desktop_0.1.0_universal.dmg

​
Configuration

​
API Endpoint

Set the Shannon API endpoint via environment variable: 
# .env.local
NEXT_PUBLIC_API_URL=http://localhost:8080
For production deployments: 
NEXT_PUBLIC_API_URL=https://api.your-domain.com

​
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

npm install @tauri-apps/plugin-shell

​
Universal Binary Requirements (macOS)

Ensure both Rust targets are installed: 
rustup target list --installed
# Should show:
# aarch64-apple-darwin
# x86_64-apple-darwin

​
Connection Issues

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

​
Clean Rebuild

rm -rf .next out src-tauri/target/release/bundle
npm run tauri:build

​
Technology Stack

ComponentTechnology
FrameworkNext.js 16 (Turbopack)
RuntimeTauri 2.x
UIShadcn/ui + Tailwind CSS
StateRedux Toolkit
BackendShannon Gateway API

​
Next Steps

Installation

Set up Shannon services

Quick Start

Submit your first task

Streaming

Understand real-time events

API Reference

Full API documentation