omi

<div align="center">

# **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.

[![Discord](https://img.shields.io/discord/1192313062041067520?label=Discord&logo=discord&logoColor=white&style=for-the-badge)](http://discord.omi.me)&ensp;
[![GitHub Repo stars](https://img.shields.io/github/stars/BasedHardware/Omi?style=for-the-badge)](https://github.com/BasedHardware/Omi)&ensp;
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[Website](https://omi.me/) · [Developer Docs](https://docs.omi.me/) · [Help Center](https://help.omi.me) · [Discord](http://discord.omi.me)

</div>

## What is Omi?

Omi is an open-source AI wearable platform: a necklace that captures conversations, apps for phone and desktop, and a backend that turns what you say into memory you can search and chat with. The mobile apps, desktop apps, backend, firmware, and hardware designs are all open source in this repository (MIT); the hosted Omi Cloud service and paid plans are described at [omi.me](https://www.omi.me/).

## 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/)

In a development worktree, run `make setup` once. It installs the Git hooks and syncs the pinned backend Python environment that some pre-push checks use. Mobile and desktop environments stay opt-in.

```bash
make setup
```

<details>
<summary>Full Installation</summary>

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.template ../../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
```

</details>

<p align="center">
  <a href="https://macos.omi.me"><img src="docs/assets/readme/download-macos-badge.png" alt="Download for macOS" height="50"></a>
  <a href="https://apps.apple.com/us/app/friend-ai-wearable/id650215616