Official documentation for InterRealm - the open source coordination protocol for distributed AI agents.
Live Site: docs.interrealm.io (or wherever you host it)
This repository contains all technical documentation, specifications, guides, and examples for InterRealm.
- Getting Started - Installation, quick start, first agent
- Core Concepts - Agents, realms, capabilities, coordination
- SDK Reference - TypeScript/JavaScript API documentation
- Nexus Runtime - Deployment, configuration, monitoring
- Protocol Specification - Technical specs and standards
- Architecture - System design, data flows, security model
- Examples - Real-world implementations and use cases
- API Reference - Complete API documentation
- Main Website: interrealm.io
- GitHub Org: github.com/interrealm-io
We welcome documentation improvements! Here's how to contribute:
- Node.js >= 20.0
- npm, yarn, or pnpm