# irmindata/irmin-sdk-go architecture

> Architecture diagram of the GitHub repository irmindata/irmin-sdk-go, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/irmindata/irmin-sdk-go
- Repository: https://github.com/irmindata/irmin-sdk-go

## Overview

##### Project type and purpose
- This is an open-source Software Development Kit (SDK) for Go (“Irmin SDK for Go-lang”), providing Go clients to interact with the Irmin data platform.
- There are two API client modules (“core-api” and “connector”), a set of domain models, and utility functions—all packaged for consumption by downstream Go code.

##### File structure
- Top-level packages:
- core-api/       – Core Irmin API client (HTTP methods for branches, commits, objects, users, workflows, etc.)
- connector/      – Connector API client (operations, pull/push, subscriptions, schema introspection)
- models/         – Plain Go structs modeling request payloads and API responses
- utils/          – Helper functions (JSON schema generation, CLI flag parsing, file handling, data preparation, zipping)
- Configuration files (.golangci.yml, .github workflows) are for CI/linting and not part of core SDK logic.
- There is no frontend or database; instead, the SDK communicates with external Irmin services over HTTP/REST.

##### README for additional insights
- The README enumerates the four primary folders and describes linting.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Application
    UA["User Application"]:::user

    %% SDK Modules Group
    subgraph "Irmin Go SDK"
        direction TB
        CAM["core-api\n(Client Module)"]:::sdk
        CONM["connector\n(Client Module)"]:::sdk
        MOD["models\n(Package)"]:::models
        UTM["utils\n(Package)"]:::utils
    end

    %% External Services
    IRCore["Irmin Core API Server"]:::external
    IRConnServ["Irmin Connector Service"]:::external

    %% Relationships
    UA -->|"import & call"| CAM
    UA -->|"import & call"| CONM
    UA -->|"import & call"| UTM

    CAM -->|"depends on"| MOD
    CONM -->|"depends on"| MOD

    CAM -->|"HTTP GET/POST"| IRCore
    CONM -->|"HTTP/WebSocket"| IRConnServ

    %% Click Events
    click CAM "https://github.com/irmindata/irmin-sdk-go/tree/development/core-api/"
    click CONM "https://github.com/irmindata/irmin-sdk-go/tree/development/connector/"
    click MOD "https://github.com/irmindata/irmin-sdk-go/tree/development/models/"
    click UTM "https://github.com/irmindata/irmin-sdk-go/tree/development/utils/"

    %% Styles
    classDef sdk fill:#E0F7FA,stroke:#006064,color:#000;
    classDef external fill:#E8F5E9,stroke:#2E7D32,color:#000;
    classDef models fill:#FFF3E0,stroke:#EF6C00,color:#000;
    classDef utils fill:#ECEFF1,stroke:#546E7A,color:#000;
    classDef user fill:#F3E5F5,stroke:#6A1B9A,color:#000;
```
