OpenSentinel Documentation

The open-source AI agent platform with persistent memory, workflow automation, sub-agents, and enterprise security. Deploy on your infrastructure in minutes.

🚀

Get Started

Install OpenSentinel and send your first message in under a minute.

📦

Use as a Library

npm install opensentinel
Add AI to any project.

🐳

Deploy with Docker

Run the full platform with dashboard, all channels, and persistent memory.

What is OpenSentinel?

OpenSentinel is a self-hosted AI agent operating system. It connects to your messaging platforms (Telegram, Discord, Slack, WhatsApp, and more), processes messages through Claude's AI brain with a full agentic RAG pipeline (tool pre-classification, memory middleware, pipeline orchestration), executes tools, remembers context across sessions via vector-based memory, and automates multi-step workflows. A real-time Brain Dashboard visualizes the AI's thinking process. File-generation tools provide secure download links. Image and document uploads are analyzed via Claude's vision and the built-in document parser. Five ML algorithms power intent classification, anomaly detection, and cost forecasting. It runs on your infrastructure — your data never leaves your network.

  ┌──────────────┐     ┌─────────────────────────────┐     ┌──────────────┐
   Telegram            OpenSentinel Core                  Text     
   Discord                                              Voice TTS  
   Slack             Claude Brain  123 Tools           PDF/Word   
   WhatsApp   │────▶│  Agentic RAG   5 Agents   │────▶│  Excel/PPT   
   Web / API         Workflows     Plugins             Charts    
   Voice             Scheduler     MCP               AI Images   
  └──────────────┘     └──────────────┬──────────────┘     └──────────────┘
                                  
                      ┌───────────┴───────────┐
                       PostgreSQL + pgvector 
                       Redis + BullMQ        
                      └───────────────────────┘

Key Capabilities

🧠

Agentic RAG Memory

Full agentic RAG pipeline with tool pre-classification, memory middleware, pgvector, HyDE, re-ranking, and auto-extraction. Remembers across all sessions.

Workflow Automation

IFTTT-like engine with time, webhook, and event triggers. BullMQ scheduler for reliable execution.

🤖

Sub-Agent System

Research, Coding, Writing, and Analysis agents with shared context and parallel coordination.

💬

Multi-Channel Gateway

Telegram, Discord, Slack, WhatsApp, Signal, iMessage, WebSocket, web dashboard, REST API, and voice.

🔒

Enterprise Security

2FA, encrypted vault, audit logging, GDPR compliance, command sandboxing, and plugin isolation.

📊

Brain Dashboard

Real-time pipeline visualization, terminal-style activity feed, agent panel, and score gauges. Watch the AI think.

🔌

Plugins & MCP

Sandboxed plugin system with lifecycle management. Native Model Context Protocol server support.

📥

File Downloads & Uploads

Secure token-based file download UI for generated files. Upload images for vision analysis or documents for automatic parsing (PDF, DOCX, CSV, and more).

📉

ML Algorithms

5 built-in ML algorithms: Naive Bayes, Isolation Forest, K-Means, Markov Chain, Linear Regression. Powers intent parsing, anomaly detection, and cost forecasting.

💹

Financial Data

Finnhub for real-time stock quotes, news sentiment, and earnings. FRED for GDP, CPI, unemployment, and interest rates. Trend detection via ML.

Quick Start

Terminal
# As an NPM library (simplest)
$ npm install opensentinel

# Or deploy the full platform
$ git clone https://github.com/dsiemon2/OpenSentinel.git
$ cd OpenSentinel && cp .env.example .env
$ docker compose up -d      # PostgreSQL + Redis
$ bun install && bun run start

# Or start from a template
$ cd templates/ai-sales-agent
$ CLAUDE_API_KEY=sk-ant-... bun run start
💡
Just need the library? npm install opensentinel is all you need. No Docker, no database. Add a Claude API key and start chatting. Learn more →

👉 Start Here

📚 Learn More

🔗 Integrations