### Install Dependencies and Run Development Server

Source: https://github.com/basedhardware/omi/blob/main/desktop/windows/README.md

Installs project dependencies, copies the example environment file, and starts the development server. Ensure you copy the .env.example to .env before starting.

```bash
npm install
cp .env.example .env
npm run dev
```

--------------------------------

### Set Up Example App Dependencies

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/ReactNative.mdx

Navigate to the example app directory and install its dependencies.

```bash
cd example
npm install
```

--------------------------------

### Install iOS Pods for Example App

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/ReactNative.mdx

Install native dependencies for the example app on iOS.

```bash
cd ios
pod install
```

--------------------------------

### Run Omi SDK Example

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/python.mdx

Execute the Python example script to start the Omi device connection, audio processing, and transcription.

```bash
python examples/main.py
```

--------------------------------

### Start Development Server

Source: https://github.com/basedhardware/omi/blob/main/sdks/react-native/example/README.md

Start the Expo development server to run the React Native example app.

```bash
npm start
# or
yarn start
```

--------------------------------

### Install Dependencies and Configure Environment

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-slack-app/README.md

Installs project dependencies and sets up the environment variables for Slack and OpenAI API keys. Ensure to copy the example environment file and fill in your credentials.

```bash
cd slack

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Configure environment
cp .env.example .env
# Edit .env with your API keys
```

--------------------------------

### Install Dependencies and Configure Environment

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-twitter-app/README.md

Clone the repository, set up a Python virtual environment, and install project dependencies. Copy the example environment file and edit it with your API keys and configuration settings.

```bash
git clone https://github.com/aaravgarg/omi-twitter-app.git
cd omi-twitter-app

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

pip install -r requirements.txt

cp .env.example .env
# Edit .env with your API keys
```

--------------------------------

### Install Dependencies and Configure Environment

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-github-app/README.md

Installs project dependencies using pip and sets up the environment by copying and editing the .env example file. Ensure Python 3.10+ is installed.

```bash
# Clone the repository
cd github

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Configure environment
cp .env.example .env
# Edit .env with your API keys
```

--------------------------------

### Run Setup Script for iOS or Android

Source: https://github.com/basedhardware/omi/blob/main/app/AGENTS.md

Execute the setup script to perform necessary tasks like pub get, build_runner, gen-l10n, and flavor configuration. Specify 'ios' or 'android' as an argument.

```bash
bash setup.sh ios    # or: bash setup.sh android
```

--------------------------------

### Local Development Setup and Execution

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-clickup-app/README.md

Steps to set up a Python virtual environment, install dependencies, and run the ClickUp Voice Task Creator locally. Access the test interface via the provided URL.

```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python main.py
```

--------------------------------

### Install Dependencies and Run Local Server

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-notion-app/README.md

Install project dependencies using pip and start the main Python application for local development.

```bash
pip install -r requirements.txt
python main.py
```

--------------------------------

### Local Development Setup

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-arxiv-app/README.md

Commands to set up a Python virtual environment, install dependencies, and run the Omi app locally.

```bash
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
uvicorn main:app --reload --port 8080
```

--------------------------------

### Install Dependencies and Run Locally

Source: https://github.com/basedhardware/omi/blob/main/plugins/uber_call/README.md

Steps to set up the development environment and run the Uber Call App locally. This includes creating a virtual environment, installing requirements, and starting the Uvicorn server.

```bash
cd plugins/uber_call
python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
uvicorn main:app --reload --port 8080
```

--------------------------------

### Install Bootloader (DevKit)

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/get_started/Flash_device.mdx

Drag the bootloader UF2 file to the device's drive to install the bootloader. This is required for first-time setup or if the bootloader is corrupted. After installation, re-enter DFU mode.

```bash
Drag `bootloader0.9.0.uf2` to the `/Volumes/XIAO-SENSE` drive
Wait for the drive to eject automatically
Put device back in DFU mode (repeat step 3)
```

--------------------------------

### Install Dependencies and Run Locally

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-crossref-app/README.md

Installs project dependencies and starts the Omi Crossref App locally. Ensure you have Python and pip installed.

```bash
pip install -r requirements.txt
uvicorn main:app --reload --host 0.0.0.0 --port 8080
```

--------------------------------

### Local Development Setup for ShipBob Integration

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-shipbob-app/README.md

Set up a Python virtual environment, install dependencies, and run the server for local development. Ensure you have a `requirements.txt` file.

```bash
# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Run the server
python main.py
```

--------------------------------

### Setup Backend Development Environment

Source: https://github.com/basedhardware/omi/blob/main/backend/AGENTS.md

Commands to set up the backend development environment, including copying the environment template, syncing Python dependencies, activating the virtual environment, and running the Uvicorn server. Ensure FFmpeg, Opus, and Redis are installed.

```bash
cp .env.template .env          # Fill in required values (see .env.template for full list)
./scripts/sync-python-deps.sh  # creates .venv from .python-version + pylock.toml
source .venv/bin/activate
uvicorn main:app --host 0.0.0.0 --port 8080
```

--------------------------------

### Install Dependencies

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-github-app/QUICKSTART.md

Navigate to the project directory, create a virtual environment, activate it, and install required packages.

```bash
cd /Users/aaravgarg/omi-ai/Code/apps/github
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

--------------------------------

### Production Build and Start

Source: https://github.com/basedhardware/omi/blob/main/web/frontend/README.md

Build the Next.js application for production and start the production server.

```bash
npm run build
npm run start
```

--------------------------------

### Start Development Server

Source: https://github.com/basedhardware/omi/blob/main/web/frontend/README.md

Start the Next.js development server using npm, yarn, or pnpm.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

--------------------------------

### Local Development Setup

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-ms365-app/README.md

Steps to set up the local development environment for the OMI MS365 app. This includes creating a virtual environment, installing dependencies, configuring environment variables, and running the application server.

```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

cp .env.example .env
# fill MICROSOFT_CLIENT_ID, MICROSOFT_CLIENT_SECRET, SESSION_SECRET

uvicorn main:app --reload --port 8080
```

--------------------------------

### Local Setup for OMI Linear Plugin

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-linear-app/README.md

Commands to set up the development environment locally. This includes navigating to the plugin directory, creating and activating a virtual environment, installing dependencies, and configuring environment variables.

```bash
cd plugins/linear

python3 -m venv venv
source venv/bin/activate

pip install -r requirements.txt

cp .env.example .env
# Edit .env with your credentials

python main.py
```

--------------------------------

### Install Omi SDK from Source

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/python.mdx

Clone the Omi repository and install the Python SDK from the source code.

```bash
git clone https://github.com/BasedHardware/omi.git
cd omi/sdks/python
pip install -e .
```

--------------------------------

### Setup Completion Check

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-slack-app/README.md

Checks if the user has successfully completed the authentication setup.

```APIDOC
## GET /setup-completed

### Description
Check if user authenticated

### Method
GET

### Endpoint
/setup-completed

```

--------------------------------

### Install Python Dependencies

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-slack-app/SETUP.md

Set up a virtual environment and install the required Python packages using pip.

```bash
# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt
```

--------------------------------

### Quickstart omi-cli commands

Source: https://github.com/basedhardware/omi/blob/main/sdks/python-cli/README.md

Begin using omi-cli by listing memories, conversations, action items, and goals. Use flags like --limit and --open to refine results.

```bash
# 2. Start using it:
omi memory list
omi conversation list --limit 5
omi action-item list --open
omi goal list
```

--------------------------------

### GET Request Example

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/apps/ChatTools.mdx

This is an example of a GET request for searching Slack messages. It includes user and app identifiers, the tool name, and the search query parameter.

```http
GET /api/search?uid=user_id&app_id=app_id&tool_name=search_slack_messages&query=meeting
```

--------------------------------

### Clone Repository and Navigate

Source: https://github.com/basedhardware/omi/blob/main/web/frontend/README.md

Clone the repository and navigate to the frontend directory to begin setup.

```bash
git clone <repository-url>
cd omi/web/frontend
```

--------------------------------

### Quick Start Against Prod Backend

Source: https://github.com/basedhardware/omi/blob/main/AGENTS.md

Use this command for a quick start that connects to the production backend without running local services.

```bash
cd desktop/macos && ./run.sh --yolo
```

--------------------------------

### Install Dependencies and Run Locally

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-pubmed-app/README.md

Install project dependencies and start the Omi PubMed App locally. Ensure you have Python and pip installed.

```bash
pip install -r requirements.txt
uvicorn main:app --reload --port 8080
```

--------------------------------

### Start Development Preview Server

Source: https://github.com/basedhardware/omi/blob/main/desktop/macos/demo/README.md

Launches the development server to preview your Remotion videos in real-time.

```bash
npm run dev
```

--------------------------------

### Local Setup for Hive Plugin

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-hive-app/README.md

Installs dependencies and sets up the virtual environment for local development of the Hive plugin. Ensure Python 3.8+ is installed.

```bash
cd plugins/hive
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
python main.py
```

--------------------------------

### Response Example for Get Memories

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/api/memories.mdx

This is an example of the JSON response structure when retrieving memories. It includes fields like ID, content, category, and timestamps.

```json
[
  {
    "id": "mem_789ghi",
    "content": "User is building an AI fitness app with personal trainer",
    "category": "interesting",
    "visibility": "private",
    "tags": [],
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z",
    "manually_added": false,
    "scoring": "01_999_1705315800",
    "reviewed": false,
    "user_review": null,
    "edited": false
  }
]
```

--------------------------------

### Install and Run Prerequisites

Source: https://github.com/basedhardware/omi/blob/main/app/e2e/FLOW-WALKER-SKILL.md

Ensure flow-walker and agent-flutter are installed globally. Start the Omi Flutter app in debug mode on an emulator or physical device and connect agent-flutter.

```bash
# flow-walker and agent-flutter must be installed globally
which flow-walker         # /usr/local/bin/flow-walker or similar
which agent-flutter       # agent-flutter-cli

# App must be running in debug mode
# Android emulator:
cd app && flutter run -d emulator-5554 --flavor dev > /tmp/omi-flutter.log 2>&1 &
# Physical device (via Mac Mini):
ssh beastoin-agents-f1-mac-mini "cd ~/omi/app && flutter run --flavor dev -d 33041JEHN18287" > /tmp/flutter-run.log 2>&1 &

# agent-flutter connected
AGENT_FLUTTER_LOG=/tmp/omi-flutter.log agent-flutter connect
```

--------------------------------

### Start Local Development Server

Source: https://github.com/basedhardware/omi/blob/main/docs/README.md

Run the Mintlify development server from the root of your documentation project. Ensure docs.json is present in the directory.

```bash
mintlify dev
```

--------------------------------

### Start Server in Production Mode

Source: https://github.com/basedhardware/omi/blob/main/plugins/apps-js/README.md

Use this command to start the server for production. It usually bundles and optimizes the application for performance.

```bash
npm start
```

--------------------------------

### Mobile App Setup

Source: https://github.com/basedhardware/omi/blob/main/AGENTS.md

Sets up the mobile application for iOS or Android development. Navigate to the app directory and run the setup script.

```bash
cd app && bash setup.sh ios
```

```bash
cd app && bash setup.sh android
```

--------------------------------

### Setup Completion Check Request

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/apps/Oauth.mdx

Omi will send a GET request to this URL to verify if the user has completed the necessary setup for your application. Ensure your endpoint returns a JSON response with `is_setup_completed` set to true.

```http
GET https://your-app.com/setup-status?uid=USER_ID
```

```json
{
  "is_setup_completed": true
}

```

--------------------------------

### Install Deepgram Helm Chart

Source: https://github.com/basedhardware/omi/blob/main/backend/charts/deepgram-self-hosted/how_to_deploy_deepgram_self_hosted_on_gke.md

Installs or upgrades the Deepgram self-hosted Helm chart using a specified values file. It deploys Deepgram into the given namespace and waits for the release to be atomic. The `watch kubectl get all` command monitors the deployment status.

```bash
helm upgrade --install <HELM_RELEASE_NAME> ./deepgram-self-hosted \
    -f ./deepgram-self-hosted/prod_omi_values.yaml \
    --namespace <DG_NAMESPACE> \
    --atomic \
    --timeout 1h

# Monitor the installation in a separate shell
watch kubectl get all

```

--------------------------------

### ClusterRole for kube-rbac-proxy

Source: https://github.com/basedhardware/omi/blob/main/backend/charts/deepgram-self-hosted/nova-3/charts/kube-prometheus-stack/charts/kube-state-metrics/README.md

Example ClusterRole definition to authorize access to kube-state-metrics endpoints when kube-rbac-proxy is enabled. This role grants GET permissions on services/kube-state-metrics.

```yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: kube-state-metrics-read
rules:
  - apiGroups: [ "" ]
    resources: ["services/kube-state-metrics"]
    verbs:
      - get
```

--------------------------------

### Verify Flutter Installation

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/AppSetup.mdx

Run this command to check your Flutter setup and diagnose any issues. Ensure you have the recommended versions of Flutter, Xcode, and Android SDK.

```bash
flutter doctor -v
```

--------------------------------

### Install Dependencies and Run Server Locally

Source: https://github.com/basedhardware/omi/blob/main/plugins/composio/README.md

Install project dependencies using pip and run the server locally with uvicorn.

```bash
# Install dependencies
pip install -r requirements.txt

# Run the server
uvicorn main:app --reload
```

--------------------------------

### Run Android Example App

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/ReactNative.mdx

Execute the command to run the example app on an Android device with USB debugging enabled.

```bash
cd example
npm run android
```

--------------------------------

### Run OMI Desktop Application

Source: https://github.com/basedhardware/omi/blob/main/desktop/macos/README.md

Builds the Swift app, starts the Rust backend, and launches the application.

```bash
./run.sh
```

--------------------------------

### Python Virtual Environment Setup

Source: https://github.com/basedhardware/omi/blob/main/backend/README.md

Steps to create and activate a Python virtual environment for managing project dependencies. This is the recommended approach for installing Python packages.

```bash
# Verify Python 3.11 before creating the virtual environment
python --version

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

# Install dependencies within the virtual environment
pip install -r requirements.txt
```

--------------------------------

### Run Android Setup Script

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/AppSetup.mdx

Execute the setup script for Android development. This command prepares the project for building and running on Android emulators or devices.

```bash
bash setup.sh android
```

--------------------------------

### Local Setup for Omi Shopify App

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-shopify-app/README.md

Commands to set up the local development environment for the Shopify app. This includes creating a virtual environment, installing dependencies, and configuring environment variables.

```bash
# Navigate to the plugin directory
cd plugins/shopify

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Copy environment file and configure
cp .env.example .env
# Edit .env with your ngrok URL

# Run the server
python main.py
```

--------------------------------

### Initialize nRF Connect SDK Workspace

Source: https://github.com/basedhardware/omi/blob/main/omi/firmware/BUILD_AND_OTA_FLASH.md

Launches the nRF Connect SDK environment, navigates to the firmware directory, and initializes the workspace with the specified SDK version. This command downloads all necessary repositories.

```bash
# Launch the nRF Connect SDK environment
nrfutil toolchain-manager launch --ncs-version v2.9.0 --shell

# Navigate to the firmware directory within the shell
cd /path/to/omi/firmware

# Create and navigate to the v2.9.0 directory
mkdir -p v2.9.0
cd v2.9.0

# Initialize nRF Connect SDK v2.9.0 workspace
west init -m https://github.com/nrfconnect/sdk-nrf --mr v2.9.0

# Download all required repositories (this may take several minutes)
west update
```

--------------------------------

### Execute Docker Build Script

Source: https://github.com/basedhardware/omi/blob/main/omi/firmware/scripts/docker-build.md

Run the main build script from the repository root to build the firmware. This script automates Docker container setup, dependency installation, and firmware compilation.

```bash
chmod +x omi/firmware/scripts/build-docker.sh
./omi/firmware/scripts/build-docker.sh
```

--------------------------------

### Get Latest Rates Example

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-frankfurter-app/README.md

Fetch the latest reference exchange rates for a given base currency using the `get_latest_rates` tool. Specify the base currency and desired target currencies.

```bash
curl -X POST http://localhost:8080/tools/get_latest_rates \
  -H "Content-Type: application/json" \
  -d '{"base_currency":"USD","to_currencies":["EUR","GBP","JPY"]}'
```

--------------------------------

### Example: Import Phone Call Transcript

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/apps/Import.mdx

Use this Python snippet to import a phone call transcript. Ensure you have the `requests` library installed and replace placeholders with your actual APP_ID, USER_ID, and API_KEY.

```python
import requests
from datetime import datetime, timezone

response = requests.post(
    f"https://api.omi.me/v2/integrations/{APP_ID}/user/conversations?uid={USER_ID}",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "started_at": datetime.now(timezone.utc).isoformat(),
        "finished_at": datetime.now(timezone.utc).isoformat(),
        "text": "John: Hi Sarah, how was your weekend?\n\nSarah: It was great! I went hiking.",
        "text_source": "audio_transcript",
        "text_source_spec": "phone_call"
    }
)
```

--------------------------------

### Open iOS Example Project

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/ReactNative.mdx

Open the `.xcworkspace` file (not `.xcodeproj`) in Xcode to run the example app on a physical iOS device.

```bash
cd example/ios
open OmiSDKExample.xcworkspace
```

--------------------------------

### Install Firmware (DevKit)

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/get_started/Flash_device.mdx

Drag the firmware UF2 file to the device's drive to install the firmware. Ignore any 'transfer incomplete' messages, as the device will restart automatically upon completion.

```bash
Drag the firmware `.uf2` file to the `/Volumes/XIAO-SENSE` drive
Wait for completion (ignore "transfer incomplete" messages)
Device will restart automatically
```

--------------------------------

### Access Local Omi Tools Manifest

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-openfoodfacts-app/README.md

After starting the local development server, access the Omi tools manifest URL to verify the integration setup. This URL is used by Omi to discover the available chat tools.

```text
http://localhost:8080/.well-known/omi-tools.json
```

--------------------------------

### Environment Configuration Example

Source: https://github.com/basedhardware/omi/blob/main/plugins/omi-slack-app/README.md

Example `.env` file structure for configuring Slack OAuth credentials, OpenAI API key, and application host/port. Replace placeholder values with your actual keys and URLs.

```env
# Slack OAuth Credentials (from api.slack.com/apps)
SLACK_CLIENT_ID=your_client_id
SLACK_CLIENT_SECRET=your_client_secret

# OAuth Redirect URL
OAUTH_REDIRECT_URL=http://localhost:8000/auth/callback

# OpenAI API Key (for AI channel matching & message extraction)
OPENAI_API_KEY=your_openai_key

# App Settings
APP_HOST=0.0.0.0
APP_PORT=8000
```

--------------------------------

### Verify omi-cli installation

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/cli/install.mdx

Check the installed version and help output to confirm successful installation.

```bash
omi --version
# omi-cli 0.3.0

omi --help
```

--------------------------------

### Example: Save to Google Cloud Storage

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/AudioStreaming.mdx

This example demonstrates how to set up an endpoint that receives raw audio bytes from Omi and saves them as WAV files in a Google Cloud Storage bucket. It requires setting up GCS, deploying the provided example code, and configuring environment variables.

```bash
export GOOGLE_APPLICATION_CREDENTIALS_JSON="Base64-encoded GCP key"
export GCS_BUCKET_NAME="Your bucket name"
```

--------------------------------

### Install omi-cli

Source: https://github.com/basedhardware/omi/blob/main/sdks/python-cli/README.md

Install the omi-cli package using pipx for an isolated environment or pip for a standard installation.

```bash
pipx install omi-cli            # recommended — isolated install
# or
pip install omi-cli
```

--------------------------------

### Install Python SDK and Dependencies

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/python.mdx

Clone the repository, set up a virtual environment, and install the Python SDK in editable mode along with development dependencies.

```bash
git clone https://github.com/BasedHardware/omi.git
cd omi/sdks/python

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install in editable mode
pip install -e .

# Install dev dependencies
pip install -e ".[dev]"
```

--------------------------------

### iOS Pod Installation

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/sdk/ReactNative.mdx

After installing dependencies, run `pod install` in the `ios` directory for iOS projects.

```bash
cd ios && pod install
```

--------------------------------

### Platform Setup Script (Android)

Source: https://github.com/basedhardware/omi/blob/main/app/e2e/SKILL.md

Executes the setup script for Android development. This includes configuring keystores, Firebase, environment variables, and launching the app in development mode.

```bash
# Android: setup + build + launch
cd app && bash setup.sh android
# → completes: keystore, Firebase config, .dev.env, flutter run --flavor dev
# → sign in with Google when app launches, complete onboarding

```

--------------------------------

### Install omi-cli with pipx

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/cli/install.mdx

Use pipx for isolated installation. Install pipx if you don't have it using package managers like brew or apt.

```bash
pipx install omi-cli
```

```bash
brew install pipx        # macOS
apt install pipx         # Debian/Ubuntu
pipx ensurepath
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/basedhardware/omi/blob/main/desktop/macos/demo/README.md

Run this command in your project's root directory to install all necessary dependencies.

```bash
npm i
```

--------------------------------

### Run iOS Setup Script

Source: https://github.com/basedhardware/omi/blob/main/docs/doc/developer/AppSetup.mdx

Execute the setup script for iOS development. This command prepares the project for building and running on iOS simulators or devices.

```bash
bash setup.sh ios
```