<div align="center">

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

</div>

Quick Start

macOS

git clone https://github.com/BasedHardware/omi.git && cd omi/desktop/macos && ./run.sh --yolo

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

git clone https://github.com/BasedHardware/omi.git
cd omi\desktop\windows
npm install
copy .env.example .env
npm run dev

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.

make setup

<details> <summary>Full Installation</summary>

For local development with the full backend stack:

1. Install prerequisites

xcode-select --install
uv --version

1. Clone and configure

git clone https://github.com/BasedHardware/omi.git
cd omi/desktop/macos
cp ../../backend/.env.example ../../backend/.env

1. Build and run

./run.sh

See desktop/macos/README.md for environment variables and credential setup.

Mobile App

cd app && bash setup.sh ios    # or: bash setup.sh android

</details> <p align="center"> <a href="https://macos.omi.me"><img src="docs/assets/readme/download-macos-badge.png" alt="Download for macOS" height="50"></a> <a href="https://apps.apple.com/us/app/friend-ai-wearable/id6502156163"><img src="docs/assets/readme/download-appstore-badge.png" alt="Download on the App Store" height="50"></a> <a href="https://play.google.com/store/apps/details?id=com.friend.ios"><img src="docs/assets/readme/download-gplay-badge.png" alt="Get it on Google Play" height="50"></a> </p> <p align="center"> <a href="https://app.omi.me">Try in Browser</a> </p> <details> <summary>How it works</summary>

┌─────────────────────────────────────────────────────────┐
│                      Your Devices                       │
│                                                         │
│  ┌──────────┐  ┌──────────────┐  ┌───────────────────┐  │
│  │ Omi      │  │ macOS App    │  │ Mobile App        │  │
│  │ Wearable │  │ (Swift/Python) │  │ (Flutter)         │  │
│  └────┬─────┘  └──────┬───────┘  └────────┬──────────┘  │
│       │    BLE         │   HTTPS/WS        │             │
└───────┼────────────────┼───────────────────┼─────────────┘
        │                │                   │
        ▼                ▼                   ▼
┌─────────────────────────────────────────────────────────┐
│                    Omi Backend (Python)                  │
│                                                         │
│  ┌─────────┐  ┌──────────┐  ┌─────────┐  ┌──────────┐  │
│  │ Listen  │  │ Pusher   │  │ VAD     │  │ Diarizer │  │
│  │ (REST)  │  │ (WS)     │  │ (GPU)   │  │ (GPU)    │  │
│  └─────────┘  └──────────┘  └─────────┘  └──────────┘  │
│                                                         │
│  ┌─────────┐  ┌──────────┐  ┌─────────┐  ┌──────────┐  │
│  │ Deepgram│  │ Firestore│  │ Redis   │  │ LLMs     │  │
│  │ (STT)   │  │ (DB)     │  │ (Cache) │  │ (AI)     │  │
│  └─────────┘  └──────────┘  └─────────┘  └──────────┘  │
└─────────────────────────────────────────────────────────┘

</details>

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.

<p align="center"> <img src="https://github.com/user-attachments/assets/834d3fdb-31b5-4f22-ae35-da3d2b9a8f59" alt="Omi Wearable" width="49%" /> <img src="https://github.com/user-attachments/assets/fdad4226-e5ce-4c55-b547-9101edfa3203" alt="Omi Glass" width="49%" /> </p>

• Buy Omi
• Buy Omi Glass Dev Kit — ESP32-S3, camera + audio
• Open Source Hardware Designs
• Buying Guide
• Build the Device
• Flash Firmware
• Integrate Your Wearable
• Hardware Specs

License

MIT — see LICENSE