Summary

Sapphire is an open-source, self-hosted framework for creating persistent, personalized AI agents. It targets users seeking a deeply integrated digital companion that remembers interactions, controls systems, and evolves over time, offering a private alternative to ephemeral assistants.

How It Works

Sapphire centers on "personas" (prompt, voice, tools, models) and enables AI self-modification of prompts and personality during conversations. Its "Mind" module offers persistent memory via semantic vector search, organized knowledge, goal management, and a privacy-first contact system. A robust plugin system manages integrations with external services (email, smart home, messaging). A unique "Tool Maker" allows the AI to create, validate, and install new tools at runtime, extending capabilities autonomously.

Quick Start & Requirements

• OS: Ubuntu 22.04+, Windows 11+, macOS (Docker-only).
• Dependencies: Python 3.11+ (Conda), 16GB+ RAM (more for local LLMs), Nvidia GPU (TTS/STT).
• Installation (Conda): Setup Conda/Git, then conda create -n sapphire python=3.11 -y, conda activate sapphire, git clone https://github.com/ddxfish/sapphire.git, pip install -r requirements.txt, python main.py.
• Installation (Docker): curl -fsSL https://raw.githubusercontent.com/ddxfish/sapphire/main/docker-compose.yml -o docker-compose.yml, docker compose up -d (Web UI only).
• Links: Windows Installer (Download Sapphire Launcher), Docker docs (DOCKER.md), Installation Guide (INSTALLATION.md).

Highlighted Details

• Extensive Integrations: Supports Discord, Telegram, Email, Google Calendar, Home Assistant, SSH, Bitcoin, Webcam, Image Gen, and more.
• Plugin Ecosystem: One-click install of community plugins (personas, tools, apps, themes) from GitHub.
• Privacy-Focused: Local-first architecture with an option to disable all cloud connections.
• Autonomous Capabilities: Features scheduled tasks ("Heartbeat"), background AI workers ("Agents"), and runtime tool creation ("Tool Maker").

Maintenance & Community

Primarily a solo developer project, with community engagement via Discord and Patreon. Contributions focus on bug reports and plugin sharing; PRs typically accepted only for single bugs.

Licensing & Compatibility

Licensed under AGPL-3.0. This copyleft license requires sharing source code modifications when deployed as a service, impacting commercial or closed-source integration.

Limitations & Caveats

Carries a significant warning about its "real power" over user systems (shell commands, autonomous actions), demanding careful toolset configuration. The Windows installer is beta. AGPL-3.0 imposes strict open-source sharing requirements for deployed services.