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
这是什么东西？Omi 是一个开源 AI，能捕捉你的屏幕和对话内容，实时转成文字，并生成摘要、待办事项，还有一个能记住你看到和听到的一切的聊天助手。它可以在桌面电脑、手机和可穿戴设备上使用。
那它到底是一个应用、一个硬件设备，还是一整套平台？三者都有：一个 macOS/Windows 桌面应用、一个支持 iOS 和 Android 的 Flutter 手机应用、一个 Python 云端后端，还有开源的可穿戴硬件——Omi 项链，以及基于 ESP32-S3 的 Omi Glass 开发者套件——都可以和手机配对使用。
我该怎么在我的 Mac 上把桌面应用跑起来？运行 macOS 快速开始构建：它会从源码编译应用，并直接连接 Omi 的云端后端启动——不需要环境变量文件，不需要凭据，也不用本地后端。你需要 macOS 14 及以上、Xcode 和 Node.js。
我必须买 Omi 项链这些功能才能用吗？不用——桌面应用本身就能捕捉你的屏幕和声音。Omi 项链或 Glass 通过与手机应用配对，可以额外提供全天候（24 小时以上）的持续捕捉，所以硬件只是可选的升级。
我可以不用 Omi 的云，全都跑在自己的后端上吗？快速开始版本的应用是设计为连接 Omi 托管的云端后端的；自己部署完整后端（Python、FastAPI、Firebase）是另一套本地开发方案，需要额外安装和配置更多依赖。
我用的是 Windows，有适合我的版本吗？有，Windows 桌面应用可以直接从源码运行，使用 .env.example 里的公开配置即可，只需要装 Node.js。
它捕捉到的屏幕和音频数据会被怎么处理？README 里没有具体说明它的数据处理方式。默认情况下，应用会把捕捉的内容发送到 Omi 的云端后端；不过由于整套代码都是开源的，你可以亲自审查到底有哪些数据离开了你的设备。
开发者可以在 Omi 之上开发自己的应用或集成吗？可以——有 Python、Swift 和 React Native 的设备 SDK，一套支持 TS、Go、Rust、C++ 和 Dart 的通用 BLE 协议 SDK，一个 MCP 服务器，还有 GitHub、Slack 集成等示例应用。开源的 AI 人格（personas）则是用 Next.js 构建的。
这个仓库里都有什么？包括一个用 Swift/SwiftUI 编写、带 Python 桌面后端的 macOS 应用，一个支持 iOS 和 Android 的 Flutter 手机应用，一个 FastAPI + Firebase 后端，项链的 nRF/Zephyr C 语言固件，Omi Glass 的 ESP32-S3 固件，以及一个用 Next.js 写的人格（personas）网页应用。
Omi Glass 开发者套件是什么？一块带摄像头和麦克风的 ESP32-S3 开发板，可以买现成的，也可以自己动手做——硬件设计是开源的，仓库里还附带了组装设备和刷固件的教程。
What are similar projects?sonicloud_opensdk, nobodywho, openhaystack, vicoa, EnvoyMesh, OpenPocketCine, EchoMuse, nomily-app
Which topics is it in?bluetooth, esp32, transcription, ai-assistant, swiftui, flutter, speech-to-text, firmware, fastapi, react-native, hardware, app
Creator
BasedHardware
Size
1.7 GB
Stars
13.8K
Updated
CommitOct 18Releasev0.12.500+12500-macosOct 17
Age
2y
Commits · 90 Days