BasedHardware / omi

# **omi**
### A 2nd brain you trust more than your 1st
Omi captures your screen and conversations, transcribes in real-time, generates summaries and action items, and gives you an AI chat that remembers everything you've seen and heard. Works on desktop, phone and wearables. Fully open source.
Trusted by 300,000+ professionals.
Website · Docs · Discord · Twitter · DeepWiki
## Quick Start
### macOS
 [code] 
Builds the macOS app, connects to the cloud backend, and launches. No env files, no credentials, no local backend.
> **Requirements:** macOS 14+, Xcode (includes Swift & code signing), Node.js
### Windows
 [code] 
Starts the Windows desktop app from source using the public config in `.env.example`.
> **Requirements:** Node.js
For development worktrees, run the baseline local setup once. It installs the Git hooks and syncs the pinned backend Python environment used by selected pre-push checks; mobile and desktop runtime environments remain opt-in.
 [code] 
The pre-push hook first runs `scripts/worktree_env_doctor.py`, which fails in seconds when a phase the push selects needs local state this worktree lacks (app dependencies, `backend/.venv`, a stale SwiftPM `.build`) and prints the one command that fixes it. Run `python3 scripts/worktree_env_doctor.py --all --fix` to bring a new worktree's app, backend, and desktop state up front.
 Full Installation 
For local development with the full backend stack:
1. Install prerequisites
 [code] 
2. Clone and configure
 [code] 
3. Build and run
 [code] 
See desktop/macos/README.md for environment variables and credential setup.
### Mobile App
 [code] 
 Try in Browser 
 How it works 
 [code] 
| Component | Path | Stack |
|-----------|------|-------|
| **macOS app** | `desktop/macos/` | Swift, SwiftUI, Python desktop backend |
| Mobile app | `app/` | Flutter (iOS & Android) |
| Backend API | `backend/` | Python, FastAPI, Firebase |
| Firmware | `omi/` | nRF, Zephyr, C |
| Omi Glass | `omiGlass/` | ESP32-S3, C |
| SDKs | `sdks/` | Device (Python/Swift/RN + multi-lang protocol) |
| AI Personas | `web/personas-open-source/` | Next.js |
## Documentation
### Getting Started
- Introduction
- Quick Start Guide
- macOS App Development
- Mobile App Setup
- Backend Setup
- Contributing — also `CONTRIBUTING.md` and `PRODUCT.md`
### Building Apps
- App Development Guide
- Example Apps — GitHub, Slack, OmiMentor
- Audio Streaming Apps
- Custom Chat Tools
- Submit to App Store
### API & SDKs
- API Reference — REST endpoints for memories, conversations, action items
- Device multi-lang protocol SDKs — shared BLE UUIDs/packet framing for TS/Go/Rust/C++/Dart
- Python device SDK — full BLE + Opus + Deepgram
- Swift device SDK
- React Native device SDK
- MCP Server — Model Context Protocol integration
### Architecture
- Backend Deep Dive
- Transcription Pipeline
- Chat System
- Audio Streaming Pipeline
- BLE Protocol
## Omi Hardware
Open-source AI wearables that pair with the mobile app for 24h+ continuous capture.
- Buy Omi
-