> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omi.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Desktop setup

> Build and run the Omi macOS desktop app from source.

The Omi desktop app for macOS lives in [`desktop/macos/`](https://github.com/BasedHardware/omi/tree/main/desktop/macos). It is a Swift Package Manager project, and `run.sh` builds and launches it. There is no Xcode project to open.

## Setup

**1. Clone the repository**

```bash theme={null}
git clone https://github.com/BasedHardware/omi.git
cd omi/desktop/macos
```

**2. Install the prerequisites**

Install the toolchain and code-signing identity listed in the [desktop README](https://github.com/BasedHardware/omi/blob/main/desktop/macos/README.md#development).

**3. Build and run a named bundle**

```bash theme={null}
OMI_APP_NAME="omi-dev" ./run.sh
```

This builds the app, starts a local Python backend, and launches the bundle. Always use a named `omi-*` bundle, so you never install over the production Omi or Omi Beta apps.

## Where the details live

The macOS component keeps its own guides next to the code: [`desktop/macos/README.md`](https://github.com/BasedHardware/omi/blob/main/desktop/macos/README.md) and `desktop/macos/docs/` cover the build flavors, signing, testing, and release process. Those docs are the source of truth; this page only points you there.

For what the shipped app does (capture modes, permissions, surfaces), see [Omi for Mac](https://docs.omi.me/onboarding/omi-macos.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.