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
Что это такое?Omi — это open-source ИИ, который записывает ваш экран и разговоры, расшифровывает их в реальном времени и превращает в краткие пересказы, список дел и чат, который помнит всё, что вы видели и слышали. Работает на компьютере, телефоне и носимых устройствах.
Так это приложение, гаджет или целая платформа?И то, и другое, и третье: десктоп-приложение для macOS/Windows, мобильное приложение на Flutter для iOS и Android, облачный бэкенд на Python, а ещё open-source носимые устройства — кулон Omi и dev-кит Omi Glass на ESP32-S3, которые подключаются к телефону.
Как запустить десктоп-приложение на моём Mac?Запустите сборку macOS Quick Start: она соберёт приложение из исходников и запустит его с облачным бэкендом Omi — без файлов с переменными окружения, учётных данных и локального бэкенда. Понадобятся macOS 14+, Xcode и Node.js.
Обязательно ли покупать кулон Omi, чтобы всё это работало?Нет — десктоп-приложение само записывает ваш экран и звук. Кулон Omi или Glass добавляют непрерывную запись круглые сутки за счёт подключения к мобильному приложению, так что железо — это необязательное расширение.
Могу ли я работать через свой бэкенд вместо облака Omi?Приложения из quick-start рассчитаны на работу с облачным бэкендом Omi; самостоятельный хостинг полного бэкенда (Python, FastAPI, Firebase) — это отдельная настройка локальной разработки с бóльшим числом компонентов, которые нужно установить и сконфигурировать.
У меня Windows — есть версия и для меня?Да, десктоп-приложение для Windows запускается из исходников с публичным конфигом из .env.example; нужен только Node.js.
Что происходит со всеми записями экрана и звука?В README обработка данных подробно не описана. По умолчанию приложения отправляют записи в облачный бэкенд Omi, но поскольку весь стек open-source, вы можете в точности проверить, что именно уходит с вашего устройства.
Могут ли разработчики создавать свои приложения или интеграции на базе Omi?Да — есть SDK для устройств на Python, Swift и React Native, общий SDK протокола BLE для TS, Go, Rust, C++ и Dart, MCP-сервер и примеры приложений вроде интеграций с GitHub и Slack. Open-source AI-персоны сделаны на Next.js.
Что находится в репозитории?Приложение для macOS на Swift/SwiftUI с десктоп-бэкендом на Python, мобильное приложение на Flutter для iOS и Android, бэкенд на FastAPI + Firebase, прошивка для кулона на nRF/Zephyr на C, прошивка для Omi Glass на ESP32-S3 и веб-приложение персон на Next.js.
Что такое dev-кит Omi Glass?Плата на ESP32-S3 с камерой и аудио, которую можно купить или собрать самому — аппаратные схемы открыты, а в репозитории есть инструкции по сборке устройства и прошивке.
Size
1.7 GB
Stars
13.8K
Age
2y
Commits · 90 Days