# getdictus/dictus-ios architecture

> Architecture diagram of the GitHub repository getdictus/dictus-ios, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/getdictus/dictus-ios
- Repository: https://github.com/getdictus/dictus-ios

## Overview

Dictus is an offline iOS dictation app with a system keyboard. The main workflow starts when a user invokes dictation from the keyboard: the app captures audio, runs an on-device speech engine, and hands text back for insertion. The app also manages speech models and provides optional Pro features including Smart Modes, searchable history, vocabulary, and voice notes. The README documents the cross-target App Group and audio bridge; source-index references support several internal module relationships. Unsampled implementation details are represented conservatively.

Main entry points: [`DictusKeyboard/KeyboardViewController.swift`](https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/KeyboardViewController.swift) (Dictus keyboard), [`DictusApp/DictationCoordinator.swift`](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/DictationCoordinator.swift) (Dictation coordinator), [`DictusApp/ContentView.swift`](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/ContentView.swift) (Dictus app), [`DictusShare/ShareViewController.swift`](https://github.com/getdictus/dictus-ios/blob/main/DictusShare/ShareViewController.swift) (Voice note sharing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dictation["Dictation"]
  node_app["Dictus app<br/>[ContentView.swift]"]
  node_coordinator["Dictation coordinator"]
  node_audio["Audio capture"]
  node_transcription["Speech engines"]
  node_handoff["Dictation handoff"]
  node_shared[("App Group<br/>[AppGroup.swift]")]
end

subgraph group_keyboard["Keyboard"]
  node_keyboard["Dictus keyboard"]
  node_prediction["Text prediction"]
  node_trie["Spellcheck trie"]
end

subgraph group_models["Models"]
  node_modelmanager["Model manager<br/>[ModelManager.swift]"]
  node_downloads["Background downloads"]
end

subgraph group_pro["Pro Features"]
  node_polish["Smart Modes"]
  node_history[("Transcription history")]
  node_vocabulary[("Vocabulary")]
  node_share["Voice note sharing"]
  node_voiceprocess["Voice note processing"]
  node_subscription["Pro subscription"]
end

node_user(("User"))
node_actor(("Share-sheet sender"))

node_user -->|"starts dictation"| node_keyboard
node_keyboard -->|"requests dictation"| node_app
node_app -.->|"coordinates"| node_coordinator
node_coordinator -.->|"captures audio"| node_audio
node_coordinator -.->|"transcribes audio"| node_transcription
node_transcription -.->|"produces text"| node_handoff
node_handoff -->|"returns text"| node_keyboard
node_keyboard -->|"shares state"| node_shared
node_app -->|"shares state"| node_shared
node_keyboard -.->|"requests suggestions"| node_prediction
node_prediction -->|"queries words"| node_trie
node_modelmanager -->|"starts downloads"| node_downloads
node_modelmanager -->|"prepares models"| node_coordinator
node_user -->|"shares voice note"| node_share
node_share -->|"queues note"| node_shared
node_share -.->|"notifies app"| node_voiceprocess
node_user -->|"selects Smart Mode"| node_polish
node_user -->|"searches history"| node_history
node_user -->|"teaches terms"| node_vocabulary
node_user -->|"chooses Pro"| node_subscription

click node_keyboard "https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/KeyboardViewController.swift"
click node_prediction "https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/TextPrediction/TextPredictionEngine.swift"
click node_trie "https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/TextPrediction/AOSPTrieEngine.swift"
click node_app "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/ContentView.swift"
click node_coordinator "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/DictationCoordinator.swift"
click node_audio "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Audio/UnifiedAudioEngine.swift"
click node_transcription "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Audio/ParakeetEngine.swift"
click node_handoff "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/DictationHandoff.swift"
click node_shared "https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/AppGroup.swift"
click node_modelmanager "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Models/ModelManager.swift"
click node_downloads "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Models/BackgroundModelDownloadService.swift"
click node_polish "https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/Polish/PolishPipeline.swift"
click node_history "https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/History/TranscriptionHistoryStore.swift"
click node_vocabulary "https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/Vocabulary/VocabularyStore.swift"
click node_share "https://github.com/getdictus/dictus-ios/blob/main/DictusShare/ShareViewController.swift"
click node_voiceprocess "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/VoiceNotes/VoiceNoteProcessor.swift"
click node_subscription "https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Subscription/SubscriptionManager.swift"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_coordinator,node_audio,node_transcription,node_handoff,node_shared,node_user toneBlue
class node_keyboard,node_prediction,node_trie toneAmber
class node_modelmanager,node_downloads toneMint
class node_polish,node_history,node_vocabulary,node_share,node_voiceprocess,node_subscription toneRose
class node_actor toneIndigo
```

## Components

### Dictation

- [Dictus app](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/ContentView.swift): `DictusApp/ContentView.swift`
- [Dictation coordinator](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/DictationCoordinator.swift): `DictusApp/DictationCoordinator.swift`
- [Audio capture](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Audio/UnifiedAudioEngine.swift): `DictusApp/Audio/UnifiedAudioEngine.swift`
- [Speech engines](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Audio/ParakeetEngine.swift): `DictusApp/Audio/ParakeetEngine.swift`
- [Dictation handoff](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/DictationHandoff.swift): `DictusApp/DictationHandoff.swift`
- [App Group](https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/AppGroup.swift): `DictusCore/Sources/DictusCore/AppGroup.swift`

### Keyboard

- [Dictus keyboard](https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/KeyboardViewController.swift): `DictusKeyboard/KeyboardViewController.swift`
- [Text prediction](https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/TextPrediction/TextPredictionEngine.swift): `DictusKeyboard/TextPrediction/TextPredictionEngine.swift`
- [Spellcheck trie](https://github.com/getdictus/dictus-ios/blob/main/DictusKeyboard/TextPrediction/AOSPTrieEngine.swift): `DictusKeyboard/TextPrediction/AOSPTrieEngine.swift`

### Models

- [Model manager](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Models/ModelManager.swift): `DictusApp/Models/ModelManager.swift`
- [Background downloads](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Models/BackgroundModelDownloadService.swift): `DictusApp/Models/BackgroundModelDownloadService.swift`

### Pro Features

- [Smart Modes](https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/Polish/PolishPipeline.swift): `DictusCore/Sources/DictusCore/Polish/PolishPipeline.swift`
- [Transcription history](https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/History/TranscriptionHistoryStore.swift): `DictusCore/Sources/DictusCore/History/TranscriptionHistoryStore.swift`
- [Vocabulary](https://github.com/getdictus/dictus-ios/blob/main/DictusCore/Sources/DictusCore/Vocabulary/VocabularyStore.swift): `DictusCore/Sources/DictusCore/Vocabulary/VocabularyStore.swift`
- [Voice note sharing](https://github.com/getdictus/dictus-ios/blob/main/DictusShare/ShareViewController.swift): `DictusShare/ShareViewController.swift`
- [Voice note processing](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/VoiceNotes/VoiceNoteProcessor.swift): `DictusApp/VoiceNotes/VoiceNoteProcessor.swift`
- [Pro subscription](https://github.com/getdictus/dictus-ios/blob/main/DictusApp/Subscription/SubscriptionManager.swift): `DictusApp/Subscription/SubscriptionManager.swift`

### Other components

- **User**
- **Share-sheet sender**

## Connections

- User → Dictus keyboard: starts dictation (evidence: `README.md`)
- Dictus keyboard → Dictus app: requests dictation (evidence: `README.md`)
- Dictus app → Dictation coordinator: coordinates
- Dictation coordinator → Audio capture: captures audio (evidence: `DictusApp/DictationCoordinator.swift`)
- Dictation coordinator → Speech engines: transcribes audio (evidence: `DictusApp/DictationCoordinator.swift`)
- Speech engines → Dictation handoff: produces text
- Dictation handoff → Dictus keyboard: returns text (evidence: `README.md`)
- Dictus keyboard → App Group: shares state (evidence: `README.md`)
- Dictus app → App Group: shares state (evidence: `README.md`)
- Dictus keyboard → Text prediction: requests suggestions
- Text prediction → Spellcheck trie: queries words (evidence: `DictusKeyboard/TextPrediction/TextPredictionEngine.swift`)
- Model manager → Background downloads: starts downloads (evidence: `DictusApp/Models/ModelManager.swift`)
- Model manager → Dictation coordinator: prepares models (evidence: `DictusApp/Models/ModelManager.swift`)
- User → Voice note sharing: shares voice note (evidence: `README.md`)
- Voice note sharing → App Group: queues note (evidence: `DictusShare/ShareViewController.swift`)
- Voice note sharing → Voice note processing: notifies app
- User → Smart Modes: selects Smart Mode (evidence: `README.md`)
- User → Transcription history: searches history (evidence: `README.md`)
- User → Vocabulary: teaches terms (evidence: `README.md`)
- User → Pro subscription: chooses Pro (evidence: `README.md`)
