-
Notifications
You must be signed in to change notification settings - Fork 5
Home
NJX-njx edited this page Mar 2, 2026
·
2 revisions
Your AI Soul Companion — Chat, Collaborate, Create
Self-hosted AI agent gateway across WhatsApp, Telegram, Discord, Slack, iMessage, and 30+ channels.
Welcome to the OpenSoul wiki! This is the central knowledge base for understanding, configuring, and extending OpenSoul.
| Page | Description |
|---|---|
| Getting Started | Install and run your first chat in minutes |
| Architecture | System design, components, and data flow |
| Configuration | Gateway settings, environment variables, and JSON5 config |
| Channels | Supported messaging channels and setup guides |
| Agent Runtime | Session management, routing, memory, and tool execution |
| Control UI | Browser-based dashboard for chat, config, and monitoring |
| Extension Development | Build custom channels, tools, and hooks |
| Skills & Tools | Built-in skills and tool integrations |
| CLI Reference | Command-line interface usage |
| Troubleshooting | Common issues and solutions |
| FAQ | Frequently asked questions |
| Roadmap | Project direction and planned features |
| Contributing | How to contribute to OpenSoul |
OpenSoul is a self-hosted AI agent gateway. Run one gateway process and talk to the same AI agent across WhatsApp, Telegram, Discord, Slack, iMessage, and 30+ more channels.
It is a local-first control plane: channel adapters connect into one runtime where you control model routing, memory, tools, and security boundaries.
- 30+ Channels — WhatsApp, Telegram, Signal, Discord, Slack, Teams, iMessage, Matrix, LINE, Zalo, and more
- Multi-model routing — OpenAI, Anthropic, Gemini, Bedrock, Ollama, MiniMax, OpenRouter
- 50+ Built-in skills — GitHub, Notion, Obsidian, Canvas, browser automation, etc.
- Cross-platform — Native apps for macOS, iOS, Android, Windows; Web Control UI; CLI/TUI
- Plugin SDK — Public SDK for custom channels, tools, hooks, and providers
- Self-hosted — Your data stays on your hardware, full control over everything
- Session transcript loading and enhanced session management
- Create Soulmate modal in the Control UI
- Gateway WebSocket auto-reconnect
- Improved onboarding with MiniMax support and better error feedback
- Windows desktop client with proxy detection (v0.2.3)
- CLI dev defaults and GitHub workflow validation
See the full CHANGELOG.
- Repository: github.com/NJX-njx/opensoul
- Documentation Site: njx-njx.github.io/opensoul
- Issue Tracker: GitHub Issues
- License: MIT
OpenSoul — Your AI Soul Companion | MIT License | Documentation
Getting Started
Core Concepts
Usage
Development
Links