Home > Documentation
Welcome to the EverMemOS documentation! This page serves as a comprehensive index to all available documentation.
- Competition Starter Kit - Quick start guide with code examples for all competition tracks
- Overview & Vision - Learn about EverMemOS's vision, unique advantages, and core concepts
- Quick Setup Guide - Complete installation and configuration instructions
- Basic Usage Examples - Get started with common usage patterns
- Architecture - System framework, layer design, and technology stack
- System Framework - Memory construction and perception explained
- Memory Types - Understanding different memory types (episodes, profiles, etc.)
- Complete Setup Guide - Comprehensive installation instructions
- Docker Setup - Docker services configuration and management
- Configuration Guide - Environment variables and service configuration
- MongoDB Guide - MongoDB installation and setup
- Usage Examples - All usage methods including demos, API calls, and evaluation
- Interactive Demos - Step-by-step demo walkthroughs
- Batch Operations - Process multiple messages efficiently
- Group Chat Conversations - Managing group chat with multiple participants 🚧
- Conversation Metadata Control - Fine-grained metadata management 🚧
- Memory Retrieval Strategies - Lightweight vs Agentic retrieval modes
- Agentic Retrieval Guide - In-depth agentic retrieval documentation
- Agentic Retrieval Testing - Testing and evaluation
- Memory API Documentation - Complete API specification for memory operations
- API Usage Guide - Practical API usage patterns and examples
- Getting Started for Developers - Development environment setup
- Development Guide - Architecture, design patterns, and best practices
- Development Standards - Code standards and conventions
- Bootstrap Usage - Script runner and bootstrap utilities
- Metrics Library Design - Metrics and monitoring
- Demo Guide - Interactive examples and memory extraction demos
- Data Guide - Sample conversation data and format specifications
- Evaluation Guide - Benchmarking on LoCoMo, LongMemEval, PersonaMem
- Contributing Guide - How to contribute to EverMemOS
- Changelog - Release notes and version history
- Citation - How to cite EverMemOS in your research
- Acknowledgments - Credits and thanks
Legend:
- 🚧 = Coming Soon (placeholder documentation)
Need help? Open an issue on GitHub or check our community channels.