# llagerlof/aipim architecture

> Architecture diagram of the GitHub repository llagerlof/aipim, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/llagerlof/aipim
- Repository: https://github.com/llagerlof/aipim

## Overview

##### Project type and purpose
- This is a lightweight Electron-based desktop application (Node.js + Chromium) named AIpim.
- Its purpose is to provide a fast keyboard-driven interface for one-off OpenAI API requests, returning a single answer which is copied to the clipboard.

##### File structure
- Top-level Electron files:
- main.js – Electron main process entry point
- preload.js – IPC bridge exposing safe APIs to renderer
- index.html, styles.css, config.html – HTML/CSS views for main and config windows
- configRenderer.js – Renderer logic for configuration window
- package.json – Dependencies: electron, node-fetch (or axios), clipboard integration
- Scripts:
- start.sh / start.bat – shortcuts to launch “npm start”
- assets folder holds logos and screenshots.

##### Key insights from README
- Two windows: Main Window (query and response areas) and Configuration Window (API key, model, system prompt).
- Keyboard shortcuts to send (Ctrl+Enter), copy & close (Enter×2), or cancel (Esc).
- Direct HTTP calls to OpenAI’s API and clipboard integration.

##### Main components
a. Electron Main Process
b. Renderer Processes:
– Main Window (index.html + renderer JS)
– Config Window (config.html + configRenderer.js)
c. Preload Script (preload.js)
d. OpenAI API (external service)
e. OS Clipboard & Keyboard Shortcuts
f. Local File Storage (for saving API key and user settings)

##### Relationships and data flow
- User types in Main Window → Renderer captures input
- Renderer sends IPC message via Preload → Main Process
- Main Process makes HTTPS request to OpenAI API
- OpenAI responds → Main Process forwards result via IPC → Renderer
- Renderer displays response, selects text
- On Enter×2 → Renderer triggers copy via Preload → Main Process writes to Clipboard → Application quits
- Config Window similarly uses IPC to read/write local config (e.g., JSON in user data folder)

##### Architectural patterns and design principles
- Electron multi-process model (Main vs Renderer isolation)
- IPC channels via preload.js for secure communication
- Single-responsibility windows (one for querying, one for settings)
- Minimal dependency surface and direct API integration

##### Technologies and libraries
- Electron (v37.1.0)
- Node.js built-in HTTPS or node-fetch for API calls
- OS clipboard module (electron.clipboard)
- HTML/CSS/vanilla JS for UI
- JSON file for persisting config

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Interaction
    User["User"]:::external
    User -->|"keyboard input"| MainWindowRenderer

    %% Renderer Processes
    subgraph "Renderer Processes"
        direction TB
        MainWindowRenderer["Main Window Renderer"]:::inProc
        ConfigWindowRenderer["Config Window Renderer"]:::inProc
    end

    %% Preload and Main Process
    subgraph "Main Process Context"
        direction TB
        Preload["Preload Script (IPC Bridge)"]:::inProc
        MainProcess["Electron Main Process"]:::inProc
    end

    %% External Services and OS
    OpenAI["OpenAI API"]:::external
    Clipboard["OS Clipboard"]:::external

    %% Local File Storage
    ConfigFile["Local Config File (config.json)"]:::static

    %% Static Assets and Docs
    subgraph "Static Assets & Docs"
        direction TB
        HTMLCSS["index.html / styles.css"]:::static
        ConfigHTML["config.html"]:::static
        Assets["assets/"]:::static
        Scripts["start.sh / start.bat"]:::static
        Package["package.json"]:::static
        Docs["README.md / LICENSE.md"]:::static
    end

    %% Data Flows: Query Path
    MainWindowRenderer -->|"ipcRenderer.send('query', payload)"| Preload
    Preload -->|"ipcMain.handle('query')"| MainProcess
    MainProcess -->|"fetch POST /v1/chat/completions"| OpenAI
    OpenAI -->|"response JSON"| MainProcess
    MainProcess -->|"ipcMain.send('response', data)"| Preload
    Preload -->|"ipcRenderer.on('response')"| MainWindowRenderer

    %% Data Flows: Copy & Exit
    MainWindowRenderer -->|"ipcRenderer.send('copy', text)"| Preload
    Preload -->|"ipcMain.handle('copy')"| MainProcess
    MainProcess -->|"clipboard.writeText(text)"| Clipboard

    %% Config Window Flows
    ConfigWindowRenderer -->|"ipcRenderer.invoke('getConfig')"| Preload
    Preload -->|"ipcMain.handle('getConfig')"| MainProcess
    MainProcess -->|"fs.readFile(config.json)"| ConfigFile
    MainProcess -->|"ipcMain.send('configData', data)"| Preload
    Preload -->|"ipcRenderer.on('configData')"| ConfigWindowRenderer

    ConfigWindowRenderer -->|"ipcRenderer.invoke('saveConfig', data)"| Preload
    Preload -->|"ipcMain.handle('saveConfig')"| MainProcess
    MainProcess -->|"fs.writeFile(config.json, data)"| ConfigFile

    %% Window Management
    MainProcess -->|"new BrowserWindow(main)"| MainWindowRenderer
    MainProcess -->|"new BrowserWindow(config)"| ConfigWindowRenderer

    %% Click Events
    click MainProcess "https://github.com/llagerlof/aipim/blob/master/main.js"
    click Preload "https://github.com/llagerlof/aipim/blob/master/preload.js"
    click HTMLCSS "https://github.com/llagerlof/aipim/blob/master/index.html"
    click HTMLCSS "https://github.com/llagerlof/aipim/blob/master/styles.css"
    click ConfigHTML "https://github.com/llagerlof/aipim/blob/master/config.html"
    click ConfigWindowRenderer "https://github.com/llagerlof/aipim/blob/master/configRenderer.js"
    click Assets "https://github.com/llagerlof/aipim/tree/master/assets/"
    click Scripts "https://github.com/llagerlof/aipim/blob/master/start.sh"
    click Scripts "https://github.com/llagerlof/aipim/blob/master/start.bat"
    click Package "https://github.com/llagerlof/aipim/blob/master/package.json"
    click Docs "https://github.com/llagerlof/aipim/blob/master/README.md"
    click Docs "https://github.com/llagerlof/aipim/blob/master/LICENSE.md"

    %% Styles
    classDef inProc fill:#d0e7ff,stroke:#000,stroke-width:1px
    classDef external fill:#e2f7d0,stroke:#000,stroke-width:1px
    classDef static fill:#f0f0f0,stroke:#000,stroke-width:1px
```
