# Nomily AI

> **Recorder → Nomily AI → Your API Key → Your AI**

<p align="center">
  <img src="media/nomily-workflow-banner.png" width="100%" alt="Nomily AI BYOK voice recording workflow from recorder to transcript, summary, and AI provider">
</p>

<p align="center">
  <a href="https://github.com/Nomily-Ai/nomily-ios"><img src="https://img.shields.io/badge/iOS%20%2B%20Apple%20Watch-SwiftUI-111318?style=for-the-badge&logo=swift&logoColor=white" alt="iOS and Apple Watch client"></a>
  <a href="https://github.com/Nomily-Ai/nomily-android"><img src="https://img.shields.io/badge/Android-Jetpack%20Compose-3DDC84?style=for-the-badge&logo=android&logoColor=white" alt="Android client"></a>
  <a href="https://geekis.com"><img src="https://img.shields.io/badge/BYOK-Your%20Key%20Your%20AI-E4002B?style=for-the-badge" alt="Bring your own key"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Source--available-4B5563?style=for-the-badge" alt="Source-available licence"></a>
</p>

<p align="center">
  <a href="README.md">English</a> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.zh-TW.md">繁體中文</a>
</p>

**BYOK voice-recording companion for V05E, Apple Watch, and iPhone imports —
ASR transcription, speaker diarization, AI summaries, and local ASR endpoint
support.**

Nomily AI brings recordings into a native client, transcribes them with a provider
you configure, and generates a summary with an AI provider you choose.

This repository is the project entry point. The runnable native clients live in
[`nomily-ios`](https://github.com/Nomily-Ai/nomily-ios) and
[`nomily-android`](https://github.com/Nomily-Ai/nomily-android).

## Quick links

| 🌐 Online demo | 🎥 Video demos | 𝕏 Updates | 📚 Documentation |
|---|---|---|---|
| [Try the fixed-data preview](https://geekis.com/demo/) | [Nomily AI on YouTube Shorts](https://www.youtube.com/@Nomily-Ai/shorts) | [@nomilyai](https://x.com/nomilyai) | [Geekis.com](https://geekis.com) |

## Choose your path

| Build or need | Start here |
| --- | --- |
| Build for iPhone or Apple Watch | [nomily-ios](https://github.com/Nomily-Ai/nomily-ios) |
| Build for Android | [nomily-android](https://github.com/Nomily-Ai/nomily-android) |
| Explore the workflow without a device, key, or upload | [Try the fixed-data demo](https://geekis.com/demo/) |
| Get help, report a documentation issue, or ask about licensing | [SUPPORT.md](SUPPORT.md) · [nomily@geekis.com](mailto:nomily@geekis.com) |

This repository is not an installable client or a Docker deployment. Read the
client-specific build instructions before starting a local build.

## What is Nomily AI?

Nomily AI is not a hosted transcription account or a shared recording cloud. It is
a native companion workflow for recordings and user-configured AI services. The
app keeps the choice of transcription and summary provider with the user.

The public repositories provide source for inspection and local builds. A source
commit is not a promise of store availability, device/firmware compatibility, or
a production service release.

## What it does today

- Connects to the V05E BLE recorder workflow, downloads recordings, and manages
  a local recordings library.
- Imports recordings on iPhone, including recordings transferred from the Apple
  Watch companion.
- Transcribes live or recorded audio through Azure Speech or a user-operated
  local faster-whisper-compatible ASR endpoint; Azure transcription enables
  speaker diarization for up to 10 speakers.
- Generates summaries, titles, and translations with a configured LLM provider:
  OpenAI, Anthropic, Gemini, OpenRouter, Ollama, or a custom OpenAI-compatible
  endpoint.
- Provides native iOS / Apple Watch and Android implementations rather than a
  cross-platform wrapper.

## Privacy and provider boundaries

Nomily AI is not a hosted transcription account or a shared recording cloud. API
keys are supplied by the user and must never be committed. Keep recordings,
transcripts, device identifiers, logs, generated configuration files, and access
credentials out of issues and pull requests.

| Service layer | Data sent in a configured workflow | Who provides it |
|---|---|---|
| Nomily AI client | Recording library, transfer state, and generated files on the client | You install and operate the client. |
| Azure Speech | Audio for transcription, when Azure is selected | Your Azure account and key. |
| Local ASR endpoint | Audio for transcription, when a local endpoint is selected | You operate the endpoint. |
| LLM provider | Transcript text needed for summary, title, or translation | Your selected provider, model, endpoint, and key. |

The public repositories do not include a shared Nomily AI cloud, a bundled provider
account, or a complete self-hosted sync stack. Local ASR and Ollama are
provider integrations, not a claim that every product layer is self-hosted.

## How it works

```text
V05E recorder / Apple Watch / audio imported on iPhone
                  │
                  ▼
        Nomily AI native client
  local library · transfer · playback
                  │
        ┌─────────┴──────────┐
        ▼                    ▼
Azure Speech or        Your LLM provider
local ASR endpoint     summary · title · translation
diarization when       OpenAI · Anthropic · Gemini
Azure is selected      OpenRouter · Ollama · compatible endpoint
        │                    │
        └─────────┬──────────┘
                  ▼
         Transcript and summary
```

<p align="center">
  <img src="media/diagrams/nomily-byok-data-flow.svg" width="900" alt="Nomily AI BYOK data flow showing user-configured ASR and AI providers">
</p>

## Recording input support

| Input | Current source status | Notes |
|---|---|---|
| V05E recorder | Implemented in both clients | Primary BLE recording input; compatibility still depends on the actual device and firmware under test. |
| Audio imported on iPhone | Implemented in `nomily-ios` | iPhone is an import, management, transcription, and summary client. |
| Apple Watch microphone | Implemented in `nomily-ios` | A paired Watch companion transfers recordings to iPhone. |
| Other recorder models | Not committed | A model is not supported merely because it can record audio. |
| Android Watch companion | Not published | Do not infer a Wear OS client from the Android app source. |

<p align="center">
  <img src="media/diagrams/recording-input-support.svg" width="900" alt="Nomily AI recording input support and future-device boundary">
</p>

See the expandable [device compatibility matrix](media/devices/README.md)
before assuming a recorder model is supported.

## Apple Watch companion

After Nomily AI is installed on the paired iPhone, install its Watch companion:

1. Open the **Watch** app on iPhone and scroll to **Available Apps**.
2. Find **Nomily AI** and tap **Install**.
3. In Nomily AI on iPhone, open **Settings → Apple Watch** and confirm it shows
   **Installed**.
4. Open Nomily AI on Apple Watch and record when V05E is not with you. The
   recording syncs to the iPhone Nomily AI app for transcription, organization,
   and summaries.

| Install from Watch App | Confirm in Nomily AI settings | Record on Apple Watch |
|---|---|---|
| <img src="media/apple-watch-install-nomily-ai.png" alt="iPhone Watch app showing Nomily AI with an Install button" width="250"> | <img src="media/apple-watch-settings.png" alt="Nomily AI settings showing Apple Watch installed" width="250"> | <img src="media/apple-watch-recording.png" alt="Nomily AI ready to record on Apple Watch" width="250"> |

### Planned or not published

| Item | Status |
|---|---|
| Other recorder models and protocols | Compatibility is not committed until tested with the relevant firmware. |
| Android Watch companion | Not published. |
| RAG, MCP, shared self-hosted sync | Not represented by the current public client source; not an announced capability. |
| Online no-key demo | A fixed-data preview is live at [Geekis.com/demo](https://geekis.com/demo/). It does not upload audio, call ASR or LLM services, or store keys. |

## Repository map

| Repository | Role | Relationship |
|---|---|---|
| **nomily-app** | Project entry, cross-project documentation, licence, and preview assets | Start here. It does not contain an installable client by itself. |
| [`nomily-ios`](https://github.com/Nomily-Ai/nomily-ios) | SwiftUI client for iPhone and Apple Watch | Its own native project, build instructions, and issue tracker. |
| [`nomily-android`](https://github.com/Nomily-Ai/nomily-android) | Kotlin / Jetpack Compose client for Android | Its own native project, build instructions, and issue tracker. |
| `nomily-site` | Private static-site deployment source | Hosts setup and demo material; it is not a mobile-client source repository. |

## Build and project layout

The clients share product concepts and protocol expectations, but are separate
native implementations. Review the relevant repository before choosing a build
path:

```text
nomily-app/       project map, licence, public preview assets
nomily-ios/       iOS app, Watch companion, BLE / ASR / local library modules
nomily-android/   Android app and core protocol, crypto, audio, ASR, LLM modules
nomily-site/      private static deployment source for guides and the demo
```

| Goal | Start here |
|---|---|
| Build for iPhone or Apple Watch | [`nomily-ios`](https://github.com/Nomily-Ai/nomily-ios) — macOS, Xcode 15+, and a physical iPhone; Apple Watch optional. |
| Build for Android | [`nomily-android`](https://github.com/Nomily-Ai/nomily-android) — JDK 21, Android Studio or Gradle, and a physical Android phone. |
| Report a defect | Open an issue in the affected native-client repository with redacted reproduction steps. |
| Need support or have a project-entry question | Read [SUPPORT.md](SUPPORT.md) or email [nomily@geekis.com](mailto:nomily@geekis.com). |
| Review terms | Read the [Nomily Small Team License](LICENSE). |

## App preview

| Recordings | Transcription providers | LLM providers for summaries |
|---|---|---|
| <img src="media/app-recordings.png" alt="Nomily AI recordings library" width="200"> | <img src="media/app-asr-providers.png" alt="Nomily AI transcription provider settings" width="200"> | <img src="media/app-llm-providers.png" alt="Nomily AI LLM provider and model selection" width="200"> |

Screens use synthetic or non-sensitive preview data. Review
[`media/README.md`](media/README.md) before reusing product imagery or brand
assets.

### Android workflow gallery

| Recording detail | ASR configuration | LLM configuration | Summary templates |
|---|---|---|---|
| <img src="media/screenshots/android/recording-detail.png" alt="Android recording detail with transcript and export actions" width="180"> | <img src="media/screenshots/android/asr-providers.png" alt="Android ASR provider settings with a masked key field" width="180"> | <img src="media/screenshots/android/llm-providers.png" alt="Android LLM provider configuration using placeholder values" width="180"> | <img src="media/screenshots/android/summary-templates.png" alt="Android summary templates" width="180"> |

These screenshots use non-sensitive preview data. They show the Android client
workflow and do not promise provider availability, device compatibility, or
store release availability.

## Licence

The source is available under the [Nomily Small Team License 1.0.0](LICENSE).
It permits personal use and company use by teams of up to 10 people; larger
teams need a separate paid licence. Contact <nomily@geekis.com> for commercial
licensing. This is a source-available licence, not an OSI-approved open-source
licence.

Brand assets under [`media/`](media/) are excluded from that licence; see
[`media/README.md`](media/README.md).

## Community and security

Read [CONTRIBUTING.md](CONTRIBUTING.md) before proposing a change. For general
help, use [SUPPORT.md](SUPPORT.md). Report vulnerabilities privately according
to [SECURITY.md](SECURITY.md), never in a public issue.

## Star history

[![Star History Chart](https://api.star-history.com/svg?repos=Nomily-Ai/nomily-app&type=date&legend=top-left)](https://www.star-history.com/#Nomily-Ai/nomily-app&type=date&legend=top-left)