Developer Resources

Relevant source files

• AGENTS.md
• CLAUDE.md
• app/.editorconfig
• app/AGENTS.md
• app/CLAUDE.md
• app/README.md
• backend/.env.template
• backend/AGENTS.md
• backend/CLAUDE.md
• backend/README.md
• backend/tests/unit/test_executors.py
• backend/utils/executors.py
• backend/utils/observability/__init__.py
• backend/utils/observability/langsmith.py
• backend/utils/observability/langsmith_prompts.py
• desktop/AGENTS.md
• desktop/CLAUDE.md
• desktop/run.sh
• docs/doc/developer/AppSetup.mdx
• docs/doc/developer/AudioStreaming.mdx
• docs/doc/developer/apps/AudioStreaming.mdx
• docs/doc/developer/apps/Introduction.mdx
• docs/doc/developer/apps/Notifications.mdx
• docs/doc/developer/apps/Submitting.mdx
• docs/doc/developer/backend/Backend_Setup.mdx
• docs/doc/developer/backend/backend_deepdive.mdx
• docs/doc/developer/savingaudio.mdx
• docs/doc/get_started/Flash_device.mdx
• docs/doc/get_started/introduction.mdx
• docs/doc/getstarted.mdx
• docs/getstartedwithomi.mdx
• plugins/README.md
• scripts/pre-commit
• web/admin/AGENTS.md
• web/admin/CLAUDE.md

This page provides an introduction to the developer resources available for contributing to or building on the Omi platform. It covers the repository structure, multi-platform toolchains, environment initialization, and high-level CI/CD workflows across mobile (Flutter), backend (FastAPI), desktop (Swift/Node.js), and firmware (Zephyr/nRF).

For detailed technical instructions, refer to the child pages linked at the bottom of this document.

Repository Structure

The Omi repository is a monorepo organized into platform-specific directories. Each major component has its own setup scripts and dependency management.

Sources: AGENTS.md18 desktop/run.sh12-42 docs/getstartedwithomi.mdx13-34 app/README.md11-28

System Component Mapping

The following diagrams bridge high-level system concepts to the specific code entities and services that implement them.

Backend & AI Pipeline

This diagram maps the "Natural Language Space" of user features to the "Code Entity Space" of the backend architecture.

Sources: AGENTS.md57-88 docs/doc/developer/backend/backend_deepdive.mdx32-82

Mobile & Hardware Integration

This diagram maps device connectivity and capture features to the Flutter and native bridge entities.

Sources: AGENTS.md80-81 docs/doc/developer/backend/backend_deepdive.mdx122-136

Development Environment Overview

Multi-Platform Toolchain

Omi development requires several language-specific toolchains. Prerequisites vary by target, as detailed in the setup guides.

Component	Language	Primary Tools	Config Method
Mobile	Dart/Flutter	Flutter SDK (3.35.3), Xcode (16.4), Android Studio	setup.sh + .env
Backend	Python	FastAPI, Uvicorn, Redis, Pytest	pip install + .env
Desktop	Swift/Node.js	xcrun, Swift PM, Node.js (ACP Bridge)	run.sh
Firmware	C	Zephyr RTOS, nRF SDK, Docker	West Build System
Web	TypeScript	Next.js, npm	npm install

Sources: AGENTS.md32-40 desktop/run.sh31-33 docs/doc/developer/AppSetup.mdx30-51 docs/doc/developer/AppSetup.mdx147-154

Environment Initialization

• Mobile (Flutter): Supports automatic setup via bash setup.sh ios/android which handles pub get, build_runner, and flavor configuration for dev and prod. docs/doc/developer/AppSetup.mdx71-113 AGENTS.md18-19
• Backend (FastAPI): Relies on a .env file for API keys (OpenAI, Deepgram, Redis, Pinecone). Developers must follow strict import hierarchies and use specific executors (e.g., db_executor, llm_executor) for blocking calls in async contexts. AGENTS.md32-39 backend/README.md49-63
• Desktop (Swift): Managed via desktop/run.sh. It handles building the Swift app, starting a local Rust backend (if not skipped), and managing process lifecycles. desktop/run.sh144-165
• Firmware: Managed via the West build tool. Docker-based environments are recommended to ensure toolchain consistency. docs/getstartedwithomi.mdx75-76

Build and Release Configuration

Code Quality and Formatting

The project enforces strict coding guidelines through pre-commit hooks and automated checks:

• Backend: Mandatory use of sanitize() and sanitize_pii() from utils.log_sanitizer for logging sensitive data. AGENTS.md41-48
• Mobile: All user-facing strings must use l10n via ARB files. AGENTS.md92-93
• Formatting: Enforced by a pre-commit hook that must be linked during setup: test -f .git/hooks/pre-commit || ln -s -f ../../scripts/pre-commit .git/hooks/pre-commit. AGENTS.md17

CI/CD Pipeline

• Mobile: Uses Codemagic for building and auto-deploying to TestFlight and Google Play Store internal tracks. Firebase configuration is managed via flutterfire config for specific flavors. docs/doc/developer/AppSetup.mdx204-229
• Desktop: Deployment includes GitHub releases with Sparkle appcast for updates. run.sh provides a --yolo mode for quick testing against production backends. desktop/run.sh49-72
• Backend: Deployed to Google Kubernetes Engine (GKE) using Helm charts located in backend/charts/. AGENTS.md78

---

Child Pages

For detailed documentation on specific areas, please visit:

• Environment Setup: Step-by-step guides for configuring mobile (Flutter), backend (Python), desktop (Swift), and firmware (Zephyr) development environments.
• API Reference: Comprehensive documentation for the Omi REST API, transcription WebSocket protocol, and Model Context Protocol (MCP) SSE implementation.
• Testing Guide: Overview of the testing strategy, including pytest for backend unit tests and integration tests for transcription. AGENTS.md28-29
• CI/CD and Deployment: Details on Codemagic workflows, GitHub Actions for desktop releases, and GKE deployment for backend services.