## File: README.md ## Quick Start ### macOS ```sh 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](https://developer.apple.com/xcode/) (includes Swift & code signing), [Node.js](https://nodejs.org/) ### Windows ```powershell 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](https://nodejs.org/) 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. ```bash make setup ``` Full Installation For local development with the full backend stack: 1. Install prerequisites ```bash xcode-select --install uv --version ``` 2. Clone and configure ```bash git clone https://github.com/BasedHardware/omi.git cd omi/desktop/macos cp ../../backend/.env.example ../../backend/.env ``` 3. Build and run ```bash ./run.sh ``` See [desktop/macos/README.md](desktop/macos/README.md) for environment variables and credential setup. ### Mobile App ```bash cd app && bash setup.sh ios # or: bash setup.sh android ``` 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/`](desktop/macos/) | Swift, SwiftUI, Python desktop backend | | Mobile app | [`app/`](app/) | Flutter (iOS & Android) | | Backend API | [`backend/`](backend/) | Python, FastAPI, Firebase | | Firmware | [`omi/`](omi/) | nRF, Zephyr, C | | Omi Glass | [`omiGlass/`](omiGlass/) | ESP32-S3, C | | SDKs | [`sdks/`](sdks/) | Device (Python/Swift/RN + multi-lang protocol) | | AI Personas | [`web/personas-open-source/`](web/personas-open-source/) | Next.js | ## Documentation ### Getting Started - [Introduction](https://docs.omi.me/) - [Quick Start Guide](https://docs.omi.me/quickstart) - [macOS App Development](desktop/macos/README.md) - [Mobile App Setup](https://docs.omi.me/doc/developer/AppSetup) - [Backend Setup](https://docs.omi.me/doc/developer/backend/Backend_Setup) - [Contributing](https://docs.omi.me/doc/developer/Contribution) — also [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`PRODUCT.md`](PRODUCT.md) ### Building Apps - [App Development Guide](https://docs.omi.me/doc/developer/apps/Introduction) - [Example Apps](https://docs.omi.me/doc/developer/apps/examples/Github) — GitHub, Slack, OmiMentor - [Audio Streaming Apps](https://docs.omi.me/doc/developer/apps/AudioStreaming) - [Custom Chat Tools](https://docs.omi.me/doc/developer/apps/ChatTools) - [Submit to App Store](https://docs.omi.me/doc/developer/apps/Submitting) ### API & SDKs - [API Reference](https://docs.omi.me/api-reference/introduction) — REST endpoints for memories, conversations, action items - [Device multi-lang protocol SDKs](sdks/device/) — shared BLE UUIDs/packet framing for TS/Go/Rust/C++/Dart - [Python device SDK](sdks/python/) — full BLE + Opus + Deepgram - [Swift device SDK](sdks/swift/) - [React Native device SDK](sdks/react-native/) - [MCP Server](mcp/) — Model Context Protocol integration ### Architecture - [Backend Deep Dive](https://docs.omi.me/doc/developer/backend/backend_deepdive) - [Transcription Pipeline](https://docs.omi.me/doc/developer/backend/transcription) - [Chat System](https://docs.omi.me/doc/developer/backend/chat_system) - [Audio Streaming Pipeline](https://docs.omi.me/doc/developer/backend/listen_pusher_pipeline) - [BLE Protocol](https://docs.omi.me/doc/developer/Protocol) ## Omi Hardware Open-source AI wearables that pair with the mobile app for 24h+ continuous capture. - [Buy Omi](https://www.omi.me/pages/product) - [Buy Omi Glass Dev Kit](https://www.omi.me/glass) — ESP32-S3, camera + audio - [Open Source Hardware Designs](https://docs.omi.me/doc/hardware/consumer/electronics) - [Buying Guide](https://docs.omi.me/doc/assembly/Buying_Guide) - [Build the Device](https://docs.omi.me/doc/assembly/Build_the_device) - [Flash Firmware](https://docs.omi.me/doc/get_started/Flash_device) - [Integrate Your Wearable](https://docs.omi.me/doc/integrations) - [Hardware Specs](https://docs.omi.me/doc/hardware/DevKit2) ## License MIT — see [LICENSE](LICENSE) --- ## File: docs/README.md # Mintlify Starter Kit Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including - Guide pages - Navigation - Customizations - API Reference pages - Use of popular components ### /Development Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command ``` npm i mintlify ``` Run the following command at the root of your documentation (where docs.json is) ``` mintlify dev ``` ### Publishing Changes Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. #### Troubleshooting - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with `docs.json`