​
Welcome to MentraOS Cloud

This is the internal documentation for developers working on the MentraOS Cloud codebase. Here you’ll find detailed information about the cloud architecture, services, managers, and how to set up your development environment.

Cloud Architecture Overview

Understand how the cloud orchestrates communication between glasses, mobile apps, and third-party applications.

​
Getting Started

Essential resources for cloud development.

Local Development Setup

Run the cloud locally with Docker, ngrok, and connect your mobile app.

Authentication Flow

Understand JWT authentication and session management.

User Sessions

Learn about UserSession - the core entity managing connections.

Message Types

All message types flowing between glasses, cloud, and apps.

​
Core Architecture

Deep dive into the cloud’s internal structure.

WebSocket Service

Routes connections between glasses and apps

Session Service

Orchestrates UserSession lifecycle

UserSession Class

The heart of the system - manages everything

Managers Pattern

Specialized managers for different concerns

Subscription Service

Controls data flow to apps

Message Types

All SDK types and interfaces

​
Manager Documentation

Detailed guides for each UserSession manager.

App Manager

App lifecycle, webhooks, and resurrection

Audio Manager

Audio processing and distribution

Display Manager

Display throttling and prioritization

Transcription Manager

Multi-provider speech-to-text

​
Join the Community

Discord

Chat with other developers and get help from the team.

GitHub

Contribute to MentraOS and see the source code.