# vbu00/klick architecture

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

- Interactive diagram: https://gitdiagram.com/vbu00/klick
- Repository: https://github.com/vbu00/klick

## Overview

kl!ck is a Windows and macOS VPN client built around mihomo. Users add a subscription, server link, or configuration; the client presents connection and routing controls, while a privileged service manages VPN state and applies traffic routing. The graph preserves documented subscription, routing, diagnostics, Kill Switch, and tray capabilities, plus the UI-to-service boundary and configuration layer. Some service and platform details are represented at subsystem level because their source was indexed but not excerpted; those links are marked unverified where needed.

Main entry points: [`crates/klick-service/src/engine.rs`](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/engine.rs) (State engine), [`crates/klick-ui/src/main.rs`](https://github.com/vbu00/klick/blob/main/crates/klick-ui/src/main.rs) (Desktop shell), [`ui/src/screens`](https://github.com/vbu00/klick/tree/main/ui/src/screens) (App screens), [`ui/src/lib/store.tsx`](https://github.com/vbu00/klick/blob/main/ui/src/lib/store.tsx) (UI state)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["User interface"]
  node_screens["App screens"]
  node_ui_state["UI state<br/>[store.tsx]"]
  node_ui_transport["UI transport<br/>[transport.ts]"]
  node_native_ui["Desktop shell<br/>[main.rs]"]
  node_bridge["Service bridge<br/>[bridge.rs]"]
end

subgraph group_domain["Connection and routing"]
  node_connection_inputs["Connection inputs<br/>[convert.rs]"]
  node_subscription_fetch["Subscription fetch<br/>[subs.rs]"]
  node_connection_model["Settings model<br/>[model.rs]"]
  node_deep_links["Deep links<br/>[deeplink.rs]"]
  node_config_compile["Routing compiler<br/>[compile.rs]"]
end

subgraph group_service["Service runtime"]
  node_service_engine["State engine<br/>[engine.rs]"]
  node_service_entry["Service entry<br/>[main.rs]"]
  node_core_process["Core process<br/>[core.rs]"]
  node_state_storage[("Settings storage<br/>[storage.rs]")]
  node_ip_diagnostics["IP diagnostics<br/>[ipcheck.rs]"]
  node_kill_switch["Kill Switch<br/>[killswitch.rs]"]
  node_live_connections["Live connections<br/>[neighbors.rs]"]
  node_network_watch["Network watch<br/>[netwatch.rs]"]
end

subgraph group_platform["Platform integration"]
  node_os_network["OS networking<br/>[netconf.rs]"]
  node_program_rules["Program rules<br/>[programs.rs]"]
  node_browser_proxy["Browser proxy<br/>[browsers.rs]"]
end

node_user(("User"))
node_external_core["mihomo"]
node_external_ip["IP check services"]

node_user -->|"uses"| node_screens
node_screens -->|"updates"| node_ui_state
node_ui_state -->|"calls"| node_ui_transport
node_ui_transport -.->|"invokes"| node_native_ui
node_native_ui -->|"starts events"| node_bridge
node_user -->|"provides"| node_connection_inputs
node_connection_inputs -.->|"fetches subscription"| node_subscription_fetch
node_service_engine -->|"fetches"| node_subscription_fetch
node_service_engine -.->|"manages"| node_connection_model
node_service_engine -.->|"builds config"| node_config_compile
node_service_engine -->|"loads and saves"| node_state_storage
node_service_entry -->|"starts"| node_service_engine
node_service_engine -->|"controls"| node_core_process
node_config_compile -->|"produces config"| node_external_core
node_service_engine -->|"checks IP"| node_ip_diagnostics
node_ip_diagnostics -->|"queries"| node_external_ip
node_service_engine -->|"controls"| node_kill_switch
node_service_engine -->|"queries"| node_live_connections
node_service_engine -->|"uses"| node_network_watch
node_service_engine -.->|"configures networking"| node_os_network
node_service_engine -->|"manages"| node_program_rules
node_service_engine -.->|"queries"| node_browser_proxy
node_user -->|"opens link"| node_deep_links
node_deep_links -.->|"opens app"| node_native_ui

click node_screens "https://github.com/vbu00/klick/tree/main/ui/src/screens"
click node_ui_state "https://github.com/vbu00/klick/blob/main/ui/src/lib/store.tsx"
click node_ui_transport "https://github.com/vbu00/klick/blob/main/ui/src/lib/transport.ts"
click node_native_ui "https://github.com/vbu00/klick/blob/main/crates/klick-ui/src/main.rs"
click node_bridge "https://github.com/vbu00/klick/blob/main/crates/klick-ui/src/bridge.rs"
click node_connection_inputs "https://github.com/vbu00/klick/blob/main/crates/klick-core/src/convert.rs"
click node_subscription_fetch "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/subs.rs"
click node_connection_model "https://github.com/vbu00/klick/blob/main/crates/klick-core/src/model.rs"
click node_deep_links "https://github.com/vbu00/klick/blob/main/crates/klick-core/src/deeplink.rs"
click node_config_compile "https://github.com/vbu00/klick/blob/main/crates/klick-core/src/compile.rs"
click node_service_engine "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/engine.rs"
click node_service_entry "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/main.rs"
click node_core_process "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/core.rs"
click node_state_storage "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/storage.rs"
click node_ip_diagnostics "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/ipcheck.rs"
click node_kill_switch "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/killswitch.rs"
click node_live_connections "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/neighbors.rs"
click node_network_watch "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/netwatch.rs"
click node_os_network "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/unix/netconf.rs"
click node_program_rules "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/programs.rs"
click node_browser_proxy "https://github.com/vbu00/klick/blob/main/crates/klick-service/src/browsers.rs"

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_screens,node_ui_state,node_ui_transport,node_native_ui,node_bridge,node_user toneBlue
class node_connection_inputs,node_subscription_fetch,node_connection_model,node_deep_links,node_config_compile toneAmber
class node_service_engine,node_service_entry,node_core_process,node_state_storage,node_ip_diagnostics,node_kill_switch,node_live_connections,node_network_watch toneMint
class node_os_network,node_program_rules,node_browser_proxy toneRose
class node_external_core,node_external_ip toneIndigo
```

## Components

### User interface

- [App screens](https://github.com/vbu00/klick/tree/main/ui/src/screens): `ui/src/screens`
- [UI state](https://github.com/vbu00/klick/blob/main/ui/src/lib/store.tsx): `ui/src/lib/store.tsx`
- [UI transport](https://github.com/vbu00/klick/blob/main/ui/src/lib/transport.ts): `ui/src/lib/transport.ts`
- [Desktop shell](https://github.com/vbu00/klick/blob/main/crates/klick-ui/src/main.rs): `crates/klick-ui/src/main.rs`
- [Service bridge](https://github.com/vbu00/klick/blob/main/crates/klick-ui/src/bridge.rs): `crates/klick-ui/src/bridge.rs`

### Connection and routing

- [Connection inputs](https://github.com/vbu00/klick/blob/main/crates/klick-core/src/convert.rs): `crates/klick-core/src/convert.rs`
- [Subscription fetch](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/subs.rs): `crates/klick-service/src/subs.rs`
- [Settings model](https://github.com/vbu00/klick/blob/main/crates/klick-core/src/model.rs): `crates/klick-core/src/model.rs`
- [Deep links](https://github.com/vbu00/klick/blob/main/crates/klick-core/src/deeplink.rs): `crates/klick-core/src/deeplink.rs`
- [Routing compiler](https://github.com/vbu00/klick/blob/main/crates/klick-core/src/compile.rs): `crates/klick-core/src/compile.rs`

### Service runtime

- [State engine](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/engine.rs): `crates/klick-service/src/engine.rs`
- [Service entry](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/main.rs): `crates/klick-service/src/main.rs`
- [Core process](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/core.rs): `crates/klick-service/src/core.rs`
- [Settings storage](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/storage.rs): `crates/klick-service/src/storage.rs`
- [IP diagnostics](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/ipcheck.rs): `crates/klick-service/src/ipcheck.rs`
- [Kill Switch](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/killswitch.rs): `crates/klick-service/src/killswitch.rs`
- [Live connections](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/neighbors.rs): `crates/klick-service/src/neighbors.rs`
- [Network watch](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/netwatch.rs): `crates/klick-service/src/netwatch.rs`

### Platform integration

- [OS networking](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/unix/netconf.rs): `crates/klick-service/src/unix/netconf.rs`
- [Program rules](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/programs.rs): `crates/klick-service/src/programs.rs`
- [Browser proxy](https://github.com/vbu00/klick/blob/main/crates/klick-service/src/browsers.rs): `crates/klick-service/src/browsers.rs`

### Other components

- **User**
- **mihomo**
- **IP check services**

## Connections

- User → App screens: uses
- App screens → UI state: updates (evidence: `ui/src/App.tsx`)
- UI state → UI transport: calls (evidence: `ui/src/lib/store.tsx`)
- UI transport → Desktop shell: invokes
- Desktop shell → Service bridge: starts events (evidence: `crates/klick-ui/src/main.rs`)
- User → Connection inputs: provides
- Connection inputs → Subscription fetch: fetches subscription
- State engine → Subscription fetch: fetches (evidence: `crates/klick-service/src/engine.rs`)
- State engine → Settings model: manages
- State engine → Routing compiler: builds config
- State engine → Settings storage: loads and saves (evidence: `crates/klick-service/src/engine.rs`)
- Service entry → State engine: starts (evidence: `crates/klick-service/src/main.rs`)
- State engine → Core process: controls (evidence: `crates/klick-service/src/engine.rs`)
- Routing compiler → mihomo: produces config (evidence: `crates/klick-core/src/compile.rs`)
- State engine → IP diagnostics: checks IP (evidence: `crates/klick-service/src/engine.rs`)
- IP diagnostics → IP check services: queries
- State engine → Kill Switch: controls (evidence: `crates/klick-service/src/engine.rs`)
- State engine → Live connections: queries (evidence: `crates/klick-service/src/engine.rs`)
- State engine → Network watch: uses (evidence: `crates/klick-service/src/engine.rs`)
- State engine → OS networking: configures networking
- State engine → Program rules: manages (evidence: `crates/klick-service/src/engine.rs`)
- State engine → Browser proxy: queries
- User → Deep links: opens link
- Deep links → Desktop shell: opens app
