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
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
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.
xcode-select --install
uv --version
2. Clone and configure
git clone https://github.com/BasedHardware/omi.git
cd omi/desktop/macos
cp ../../backend/.env.example ../../backend/.env
3. Build and run
./run.sh
See [desktop/macos/README.md](https://github.com/BasedHardware/omi/blob/HEAD/desktop/macos/README.md) for environment variables and credential setup.
### Mobile App
cd app && bash setup.sh ios # or: bash setup.sh android
┌─────────────────────────────────────────────────────────┐
│ 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) │ │
│ └─────────┘ └──────────┘ └─────────┘ └──────────┘ │
│ │
│ ┌─────────┐ ┌──────────┐ ┌─────────┐ ┌──────────┐ │
│ │ Soniox │ │ Firestore│ │ Redis │ │ LLMs │ │
│ │ (STT) │ │ (DB) │ │ (Cache) │ │ (AI) │ │
│ └─────────┘ └──────────┘ └─────────┘ └──────────┘ │
└─────────────────────────────────────────────────────────┘
| Component | Path | Stack |
|-----------|------|-------|
| **macOS app** | [`desktop/macos/`](https://github.com/BasedHardware/omi/blob/HEAD/desktop/macos/) | Swift, SwiftUI, Python desktop backend |
| Mobile app | [`app/`](https://github.com/BasedHardware/omi/blob/HEAD/app/) | Flutter (iOS & Android) |
| Backend API | [`backend/`](https://github.com/BasedHardware/omi/blob/HEAD/backend/) | Python, FastAPI, Firebase |
| Firmware | [`omi/`](https://github.com/BasedHardware/omi/blob/HEAD/omi/) | nRF, Zephyr, C |
| Omi Glass | [`omiGlass/`](https://github.com/BasedHardware/omi/blob/HEAD/omiGlass/) | ESP32-S3, C |
| SDKs | [`sdks/`](https://github.com/BasedHardware/omi/blob/HEAD/sdks/) | Device (Python/Swift/RN + multi-lang protocol) |
| AI Personas | [`web/personas-open-source/`](https://github.com/BasedHardware/omi/blob/HEAD/web/personas-open-source/) | Next.js |
CONTRIBUTING.md and PRODUCT.mdOpen-source AI wearables that pair with the mobile app for 24h+ continuous capture.
MIT — see LICENSE
| 日期 | 榜单 | 排名 | 周期新增 | 总 STAR |
|---|