omi README

The project's README from github.com/BasedHardware/omi. As one markdown file: README.md.

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.

Discord  GitHub Repo stars  License: MIT

Website · Docs · Discord · Twitter · DeepWiki

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
Full Installation

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

Download for macOS Download on the App Store Get it on Google Play

Try in Browser

How it works
┌─────────────────────────────────────────────────────────┐
│                      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)     │  │
│  └─────────┘  └──────────┘  └─────────┘  └──────────┘  │
└─────────────────────────────────────────────────────────┘
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

Building Apps

API & SDKs

Architecture

Omi Hardware

Omi

Open-source AI wearables that pair with the mobile app for 24h+ continuous capture.

Omi Wearable Omi Glass

License

MIT — see LICENSE

omi (BasedHardware/omi)

Searching Database…

13.8K ·GitHub
What is this?Omi is an open-source AI that captures your screen and conversations, transcribes them in real time, and turns them into summaries, action items and a chat that remembers everything you've seen and heard. It works on desktop, phone and wearables.
So is it an app, a gadget, or a whole platform?All three: a macOS/Windows desktop app, a Flutter mobile app for iOS and Android, a Python cloud backend, plus open-source wearable hardware — the Omi necklace and an Omi Glass dev kit on ESP32-S3 — that pair with the phone.
How do I get the desktop app running on my Mac?Run the macOS Quick Start build: it compiles the app from source and launches it against Omi's cloud backend — no env files, no credentials, no local backend. You need macOS 14+, Xcode and Node.js.
Do I need to buy the Omi necklace for any of this to work?No — the desktop app captures your screen and audio on its own. The Omi necklace or Glass add continuous 24h+ capture by pairing with the mobile app, so the hardware is an optional upgrade.
Can I run everything on my own backend instead of Omi's cloud?The quick-start apps are built to talk to Omi's hosted cloud backend; hosting the full backend yourself (Python, FastAPI, Firebase) is a separate local-development setup with more prerequisites to install and configure.
I'm on Windows — is there a version for me?Yes, a Windows desktop app runs from source using the public config in .env.example; only Node.js is required.
What happens to all the screen and audio data it captures?The README doesn't spell out its data handling. By default the apps send captures to Omi's cloud backend, and since the entire stack is open source you can audit exactly what leaves your device.
Can developers build their own apps or integrations on top of Omi?Yes — there are device SDKs in Python, Swift and React Native, a shared BLE protocol SDK for TS, Go, Rust, C++ and Dart, an MCP server, and example apps like GitHub and Slack integrations. Open-source AI personas are built on Next.js.
What's inside the repo?A macOS app in Swift/SwiftUI with a Python desktop backend, a Flutter mobile app for iOS and Android, a FastAPI + Firebase backend, nRF/Zephyr firmware in C for the necklace, ESP32-S3 firmware for Omi Glass, and a Next.js personas web app.
What is the Omi Glass dev kit?An ESP32-S3 board with camera and audio that you can buy or build yourself — the hardware designs are open source, and the repo includes guides for building the device and flashing its firmware.
Size
1.6 GB
Stars
13.8K
Age
2y
Commits · 90 Days