# aekam27/miwl2 architecture

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

- Interactive diagram: https://gitdiagram.com/aekam27/miwl2
- Repository: https://github.com/aekam27/miwl2

## Overview

Miwl 2 is a local desktop workspace for writing sessions, source documents, and editable drafts, with optional voice, camera/face-matching, and cloud-text capabilities. The main workflow runs from the user through the desktop entry point and workspace bridge into a job service, which uses a configured provider and persists session results. Separate branches support document import and retrieval, voice transcription/playback, and camera/gallery/vision workflows. Relationships are based on excerpts, the SOURCE INDEX, and README statements; several subsystem internals were not sampled, so their links are limited to documented or indexed relationships.

Main entry points: [`src/miwl2/app.py`](https://github.com/aekam27/miwl2/blob/main/src/miwl2/app.py) (Desktop app), [`src/miwl2/service.py`](https://github.com/aekam27/miwl2/blob/main/src/miwl2/service.py) (Job service), [`src/miwl2/vision_ui.py`](https://github.com/aekam27/miwl2/blob/main/src/miwl2/vision_ui.py) (Vision controls), [`src/miwl2/configuration.py`](https://github.com/aekam27/miwl2/blob/main/src/miwl2/configuration.py) (Provider configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_desktop["Desktop workspace"]
  node_app["Desktop app<br/>[app.py]"]
  node_writing_ui["Writing bridge<br/>[bridge.py]"]
  node_camera_ui["Camera controls<br/>[camera_ui.py]"]
  node_documents_ui["Document controls<br/>[documents_ui.py]"]
  node_voice_ui["Voice controls<br/>[voice_ui.py]"]
  node_vision_ui["Vision controls<br/>[vision_ui.py]"]
end

subgraph group_writing["Writing workflow"]
  node_service["Job service<br/>[service.py]"]
  node_domain["Writing requests<br/>[domain.py]"]
end

subgraph group_documents["Source documents"]
  node_documents["Import and search<br/>[documents.py]"]
end

subgraph group_sensors["Voice and vision"]
  node_camera_manager["Camera streams<br/>[cameras.py]"]
  node_voice_runtime["Transcription and speech<br/>[voice.py]"]
  node_vision["Face matching<br/>[vision.py]"]
  node_gallery[("Encrypted gallery<br/>[gallery.py]")]
end

subgraph group_integrations["Providers and persistence"]
  node_configuration["Provider configuration<br/>[configuration.py]"]
  node_fixture["Fixture provider<br/>[providers.py]"]
  node_ollama["Ollama adapter<br/>[ollama.py]"]
  node_cloud["OpenAI adapter<br/>[cloud.py]"]
  node_storage[("Writing store<br/>[storage.py]")]
end

node_user(("Writer"))
node_ollama_service(("Local Ollama"))
node_openai_service(("OpenAI API"))

node_user -->|"opens workspace"| node_app
node_app -->|"creates service"| node_service
node_app -->|"installs bridge"| node_writing_ui
node_app -->|"installs controls"| node_camera_ui
node_app -->|"installs controls"| node_documents_ui
node_app -->|"installs controls"| node_voice_ui
node_app -->|"installs controls"| node_vision_ui
node_writing_ui -->|"starts jobs"| node_service
node_service -->|"persists jobs"| node_storage
node_service -->|"builds requests"| node_domain
node_service -->|"configures provider"| node_configuration
node_configuration -->|"builds adapter"| node_fixture
node_configuration -->|"builds adapter"| node_ollama
node_configuration -->|"builds adapter"| node_cloud
node_ollama -->|"sends requests"| node_ollama_service
node_cloud -->|"sends requests"| node_openai_service
node_documents_ui -->|"imports and searches"| node_documents
node_documents_ui -->|"uses workspace"| node_writing_ui
node_camera_ui -->|"controls streams"| node_camera_manager
node_voice_ui -->|"controls voice"| node_voice_runtime
node_vision_ui -->|"uses camera controls"| node_camera_ui
node_vision_ui -->|"runs matching"| node_vision
node_vision_ui -->|"manages enrollments"| node_gallery
node_vision -->|"reads profiles"| node_gallery
node_camera_manager -->|"saves settings"| node_storage

click node_app "https://github.com/aekam27/miwl2/blob/main/src/miwl2/app.py"
click node_writing_ui "https://github.com/aekam27/miwl2/blob/main/src/miwl2/bridge.py"
click node_camera_ui "https://github.com/aekam27/miwl2/blob/main/src/miwl2/camera_ui.py"
click node_documents_ui "https://github.com/aekam27/miwl2/blob/main/src/miwl2/documents_ui.py"
click node_voice_ui "https://github.com/aekam27/miwl2/blob/main/src/miwl2/voice_ui.py"
click node_vision_ui "https://github.com/aekam27/miwl2/blob/main/src/miwl2/vision_ui.py"
click node_service "https://github.com/aekam27/miwl2/blob/main/src/miwl2/service.py"
click node_domain "https://github.com/aekam27/miwl2/blob/main/src/miwl2/domain.py"
click node_documents "https://github.com/aekam27/miwl2/blob/main/src/miwl2/documents.py"
click node_camera_manager "https://github.com/aekam27/miwl2/blob/main/src/miwl2/cameras.py"
click node_voice_runtime "https://github.com/aekam27/miwl2/blob/main/src/miwl2/voice.py"
click node_vision "https://github.com/aekam27/miwl2/blob/main/src/miwl2/vision.py"
click node_gallery "https://github.com/aekam27/miwl2/blob/main/src/miwl2/gallery.py"
click node_configuration "https://github.com/aekam27/miwl2/blob/main/src/miwl2/configuration.py"
click node_fixture "https://github.com/aekam27/miwl2/blob/main/src/miwl2/providers.py"
click node_ollama "https://github.com/aekam27/miwl2/blob/main/src/miwl2/ollama.py"
click node_cloud "https://github.com/aekam27/miwl2/blob/main/src/miwl2/cloud.py"
click node_storage "https://github.com/aekam27/miwl2/blob/main/src/miwl2/storage.py"

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_writing_ui,node_camera_ui,node_documents_ui,node_voice_ui,node_vision_ui toneBlue
class node_service,node_domain toneAmber
class node_documents,node_openai_service toneMint
class node_camera_manager,node_voice_runtime,node_vision,node_gallery toneRose
class node_configuration,node_fixture,node_ollama,node_cloud,node_storage,node_user,node_ollama_service toneIndigo
```

## Components

### Desktop workspace

- [Desktop app](https://github.com/aekam27/miwl2/blob/main/src/miwl2/app.py): `src/miwl2/app.py`
- [Writing bridge](https://github.com/aekam27/miwl2/blob/main/src/miwl2/bridge.py): `src/miwl2/bridge.py`
- [Camera controls](https://github.com/aekam27/miwl2/blob/main/src/miwl2/camera_ui.py): `src/miwl2/camera_ui.py`
- [Document controls](https://github.com/aekam27/miwl2/blob/main/src/miwl2/documents_ui.py): `src/miwl2/documents_ui.py`
- [Voice controls](https://github.com/aekam27/miwl2/blob/main/src/miwl2/voice_ui.py): `src/miwl2/voice_ui.py`
- [Vision controls](https://github.com/aekam27/miwl2/blob/main/src/miwl2/vision_ui.py): `src/miwl2/vision_ui.py`

### Writing workflow

- [Job service](https://github.com/aekam27/miwl2/blob/main/src/miwl2/service.py): `src/miwl2/service.py`
- [Writing requests](https://github.com/aekam27/miwl2/blob/main/src/miwl2/domain.py): `src/miwl2/domain.py`

### Source documents

- [Import and search](https://github.com/aekam27/miwl2/blob/main/src/miwl2/documents.py): `src/miwl2/documents.py`

### Voice and vision

- [Camera streams](https://github.com/aekam27/miwl2/blob/main/src/miwl2/cameras.py): `src/miwl2/cameras.py`
- [Transcription and speech](https://github.com/aekam27/miwl2/blob/main/src/miwl2/voice.py): `src/miwl2/voice.py`
- [Face matching](https://github.com/aekam27/miwl2/blob/main/src/miwl2/vision.py): `src/miwl2/vision.py`
- [Encrypted gallery](https://github.com/aekam27/miwl2/blob/main/src/miwl2/gallery.py): `src/miwl2/gallery.py`

### Providers and persistence

- [Provider configuration](https://github.com/aekam27/miwl2/blob/main/src/miwl2/configuration.py): `src/miwl2/configuration.py`
- [Fixture provider](https://github.com/aekam27/miwl2/blob/main/src/miwl2/providers.py): `src/miwl2/providers.py`
- [Ollama adapter](https://github.com/aekam27/miwl2/blob/main/src/miwl2/ollama.py): `src/miwl2/ollama.py`
- [OpenAI adapter](https://github.com/aekam27/miwl2/blob/main/src/miwl2/cloud.py): `src/miwl2/cloud.py`
- [Writing store](https://github.com/aekam27/miwl2/blob/main/src/miwl2/storage.py): `src/miwl2/storage.py`

### Other components

- **Writer**
- **Local Ollama**
- **OpenAI API**

## Connections

- Writer → Desktop app: opens workspace (evidence: `README.md`)
- Desktop app → Job service: creates service (evidence: `src/miwl2/app.py`)
- Desktop app → Writing bridge: installs bridge (evidence: `src/miwl2/app.py`)
- Desktop app → Camera controls: installs controls (evidence: `src/miwl2/app.py`)
- Desktop app → Document controls: installs controls (evidence: `src/miwl2/app.py`)
- Desktop app → Voice controls: installs controls (evidence: `src/miwl2/app.py`)
- Desktop app → Vision controls: installs controls (evidence: `src/miwl2/app.py`)
- Writing bridge → Job service: starts jobs (evidence: `src/miwl2/bridge.py`)
- Job service → Writing store: persists jobs (evidence: `src/miwl2/service.py`)
- Job service → Writing requests: builds requests (evidence: `src/miwl2/service.py`)
- Job service → Provider configuration: configures provider (evidence: `src/miwl2/service.py`)
- Provider configuration → Fixture provider: builds adapter (evidence: `src/miwl2/configuration.py`)
- Provider configuration → Ollama adapter: builds adapter (evidence: `src/miwl2/configuration.py`)
- Provider configuration → OpenAI adapter: builds adapter (evidence: `src/miwl2/configuration.py`)
- Ollama adapter → Local Ollama: sends requests (evidence: `README.md`)
- OpenAI adapter → OpenAI API: sends requests (evidence: `README.md`)
- Document controls → Import and search: imports and searches (evidence: `src/miwl2/documents_ui.py`)
- Document controls → Writing bridge: uses workspace (evidence: `src/miwl2/documents_ui.py`)
- Camera controls → Camera streams: controls streams (evidence: `src/miwl2/camera_ui.py`)
- Voice controls → Transcription and speech: controls voice (evidence: `src/miwl2/voice_ui.py`)
- Vision controls → Camera controls: uses camera controls (evidence: `src/miwl2/vision_ui.py`)
- Vision controls → Face matching: runs matching (evidence: `src/miwl2/vision_ui.py`)
- Vision controls → Encrypted gallery: manages enrollments (evidence: `src/miwl2/vision_ui.py`)
- Face matching → Encrypted gallery: reads profiles (evidence: `src/miwl2/vision.py`)
- Camera streams → Writing store: saves settings (evidence: `src/miwl2/cameras.py`)
