Summary

MentraOS is an open-source operating system purpose-built for developing applications for smart glasses. It addresses the fragmentation in smart glass hardware by allowing developers to write a single application that runs across multiple devices, significantly streamlining the development lifecycle and distribution. The project aims to foster an open ecosystem for smart glasses, enabling developers to create and deploy apps efficiently.

How It Works

MentraOS provides a unified platform and TypeScript SDK that abstracts hardware complexities, device pairing, and data streaming. Developers focus on application logic, leveraging the SDK to access smart glasses' I/O capabilities like displays, microphones, and cameras. The system ensures cross-compatibility, allowing a single codebase to function across supported smart glass models, thereby reducing development time and effort.

Quick Start & Requirements

• Primary Install/Run: Uses bun install and bun start for mobile app development, and bun run dev for the cloud backend within Docker.
• Prerequisites: macOS or Linux (Windows has known issues), Node.js v20.x, bun or npm package manager. Android development requires Android Studio with Java SDK 17; iOS development requires Xcode. Docker and Docker Compose are needed for the cloud backend.
• Links: Documentation is available via the website and CLAUDE.md in the repository root.

Highlighted Details

• Cross-Compatibility: Write once, run on any supported smart glasses.
• TypeScript SDK: Enables rapid app development, aiming for minutes rather than months.
• Full I/O Access: Provides control over smart glasses' displays, microphones, and cameras.
• Mentra Store: A distribution platform for published smart glasses applications.

Maintenance & Community

MentraOS is community-driven, with a Discord server available for involvement. A contributors guide and "Help Wanted" issues are provided to facilitate community participation. Contact is available via email (team@mentra.glass) and Twitter (@mentralabs).

Licensing & Compatibility

Licensed under the MIT License. This permissive license allows for commercial use and integration into closed-source projects without significant restrictions.

Limitations & Caveats

The development environment has known issues on Windows, recommending macOS or Linux for setup and operation. Specific hardware compatibility is detailed in a separate list, implying potential limitations for unsupported devices.