Skip to content

xyOz-dev/Saturn

Repository files navigation

🪐

Your personal swarm of employees, without the salary.

.NET OpenRouter GitHub Stars


Warning: Some hotkeys may not work on Unix systems, we are looking into a fix (This issue is caused by the ui framework terminal.gui)

📋 Prerequisites
  • .NET 8.0 SDK or later
  • Git (Saturn requires a Git repository)
  • OpenRouter API Key (Get one here)

📦 Installation

Install as .NET Global Tool (Recommended)

# Install from NuGet
dotnet tool install --global SaturnAgent

# Or install from local package
dotnet tool install --global --add-source ./nupkg SaturnAgent

🚀 Quick Start

1️⃣ Set up your API key

# Windows (Command Prompt)
setx OPENROUTER_API_KEY your-api-key-here

# Windows (PowerShell)
$env:OPENROUTER_API_KEY = "your-api-key-here"

# macOS/Linux
export OPENROUTER_API_KEY="your-api-key-here"

2️⃣ Launch Saturn

# If installed as global tool
saturn

# If running from source
dotnet run --project Saturn

🏗️ Build Instructions
# Clone repository
git clone https://github.com/xyOz-dev/Saturn.git
cd Saturn

# Restore dependencies
dotnet restore

# Build in Release mode
dotnet build -c Release

# Create NuGet package
dotnet pack -c Release

# Run tests (if available)
dotnet test