# igmarmelis/kibridge architecture

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

- Interactive diagram: https://gitdiagram.com/igmarmelis/kibridge
- Repository: https://github.com/igmarmelis/kibridge

## Overview

KiBridge is a KiCad plugin with two user-controlled workflows: inspect/export a board for review and apply approved workspace suggestions; or send a board to the local KiRouter web app, route it, and import the result. KiRouter also provides board visualization and first-pass DRC. The graph reflects documented flows and indexed or excerpted calls; some unsampled workspace and UI internals are represented at directory level, and uncertain links are omitted.

Main entry points: [`plugin/kibridge/action_plugin.py`](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/action_plugin.py) (Toolbar actions), [`router/kirouter/server.py`](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/server.py) (HTTP API server), [`plugin/kibridge/workspace_applier.py`](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_applier.py) (Validation and apply), [`router/kirouter/router_engine/__init__.py`](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/router_engine/__init__.py) (Routing engine manager)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_plugin["KiBridge plugin"]
  node_plugin_actions["Toolbar actions<br/>[action_plugin.py]"]
  node_inspector["Board inspection<br/>[board_inspector.py]"]
  node_reports["Inspection reports<br/>[report_writer.py]"]
  node_send_board["Send board"]
  node_bridge_client["HTTP board client<br/>[kirouter_client.py]"]
  node_import_result["Import route result"]
  node_schema_version["Schema version<br/>[version.py]"]
end

subgraph group_workspace["Workspace assistance"]
  node_workspace_export["Workspace export"]
  node_workspace_open["Open workspace<br/>[workspace_open.py]"]
  node_workspace_review["Workspace suggestions"]
  node_workspace_apply["Apply suggestions<br/>[workspace_apply.py]"]
  node_applier["Validation and apply"]
  node_script_runner["Script sandbox<br/>[script_runner.py]"]
  node_safety["Safety checks<br/>[safety.py]"]
  node_board_api["Board operations API<br/>[kibridge_api.py]"]
end

subgraph group_router["KiRouter app"]
  node_server["HTTP API server<br/>[server.py]"]
  node_board_state[("Loaded board state<br/>[state.py]")]
  node_web_ui["Canvas web app"]
end

subgraph group_routing["Routing and checks"]
  node_route_manager["Routing engine manager<br/>[__init__.py]"]
  node_drc["First-pass DRC<br/>[drc.py]"]
end

subgraph group_freerouting["Freerouting adapter"]
  node_dsn_export["DSN export<br/>[dsn_export.py]"]
  node_freerouting_runner["Freerouting process<br/>[runner.py]"]
  node_ses_import["SES result import<br/>[ses_import.py]"]
end

node_kicad_user(("KiCad user"))
node_copilot(("Copilot"))
node_browser_user(("Browser user"))
node_kicad_board[("KiCad board")]

node_kicad_user -->|"uses tools"| node_plugin_actions
node_plugin_actions -->|"dispatches inspection"| node_inspector
node_inspector -->|"reads board"| node_kicad_board
node_plugin_actions -->|"writes reports"| node_reports
node_plugin_actions -->|"dispatches open"| node_workspace_open
node_workspace_open -->|"creates snapshot"| node_workspace_export
node_workspace_export -->|"uses inspection"| node_inspector
node_copilot -->|"reviews snapshot"| node_workspace_review
node_plugin_actions -->|"dispatches apply"| node_workspace_apply
node_workspace_apply -->|"invokes"| node_applier
node_applier -->|"runs scripts"| node_script_runner
node_applier -->|"checks safety"| node_safety
node_applier -->|"applies actions"| node_board_api
node_board_api -->|"modifies board"| node_kicad_board
node_plugin_actions -->|"dispatches send"| node_send_board
node_send_board -->|"builds and posts"| node_bridge_client
node_bridge_client -->|"uploads JSON"| node_server
node_server -->|"stores board"| node_board_state
node_browser_user -->|"views and controls"| node_web_ui
node_web_ui -->|"calls API"| node_server
node_server -->|"submits route"| node_route_manager
node_server -->|"runs DRC"| node_drc
node_route_manager -->|"exports design"| node_dsn_export
node_route_manager -->|"runs subprocess"| node_freerouting_runner
node_route_manager -->|"parses session"| node_ses_import
node_server -->|"reads board"| node_board_state
node_plugin_actions -->|"dispatches import"| node_import_result
node_import_result -->|"fetches route"| node_bridge_client
node_bridge_client -->|"gets result"| node_server
node_import_result -->|"backs up and applies"| node_kicad_board
node_send_board -->|"uses version"| node_schema_version

click node_plugin_actions "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/action_plugin.py"
click node_inspector "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/board_inspector.py"
click node_reports "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/report_writer.py"
click node_workspace_export "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_exporter.py"
click node_workspace_open "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_open.py"
click node_workspace_review "https://github.com/igmarmelis/kibridge/tree/main/workspace_template"
click node_workspace_apply "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_apply.py"
click node_applier "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_applier.py"
click node_script_runner "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/script_runner.py"
click node_safety "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/safety.py"
click node_board_api "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/kibridge_api.py"
click node_send_board "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/send_to_kirouter.py"
click node_bridge_client "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/kirouter_client.py"
click node_import_result "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/import_from_kirouter.py"
click node_schema_version "https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/version.py"
click node_server "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/server.py"
click node_board_state "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/state.py"
click node_web_ui "https://github.com/igmarmelis/kibridge/tree/main/router/kirouter/static"
click node_route_manager "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/router_engine/__init__.py"
click node_drc "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/drc.py"
click node_dsn_export "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/freerouting/dsn_export.py"
click node_freerouting_runner "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/freerouting/runner.py"
click node_ses_import "https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/freerouting/ses_import.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_plugin_actions,node_inspector,node_reports,node_send_board,node_bridge_client,node_import_result,node_schema_version,node_kicad_user,node_browser_user toneBlue
class node_workspace_export,node_workspace_open,node_workspace_review,node_workspace_apply,node_applier,node_script_runner,node_safety,node_board_api,node_kicad_board toneAmber
class node_server,node_board_state,node_web_ui toneMint
class node_route_manager,node_drc toneRose
class node_dsn_export,node_freerouting_runner,node_ses_import,node_copilot toneIndigo
```

## Components

### KiBridge plugin

- [Toolbar actions](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/action_plugin.py): `plugin/kibridge/action_plugin.py`
- [Board inspection](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/board_inspector.py): `plugin/kibridge/board_inspector.py`
- [Inspection reports](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/report_writer.py): `plugin/kibridge/report_writer.py`
- [Send board](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/send_to_kirouter.py): `plugin/kibridge/send_to_kirouter.py`
- [HTTP board client](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/kirouter_client.py): `plugin/kibridge/kirouter_client.py`
- [Import route result](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/import_from_kirouter.py): `plugin/kibridge/import_from_kirouter.py`
- [Schema version](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/version.py): `plugin/kibridge/version.py`

### Workspace assistance

- [Workspace export](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_exporter.py): `plugin/kibridge/workspace_exporter.py`
- [Open workspace](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_open.py): `plugin/kibridge/workspace_open.py`
- [Workspace suggestions](https://github.com/igmarmelis/kibridge/tree/main/workspace_template): `workspace_template`
- [Apply suggestions](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_apply.py): `plugin/kibridge/workspace_apply.py`
- [Validation and apply](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/workspace_applier.py): `plugin/kibridge/workspace_applier.py`
- [Script sandbox](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/script_runner.py): `plugin/kibridge/script_runner.py`
- [Safety checks](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/safety.py): `plugin/kibridge/safety.py`
- [Board operations API](https://github.com/igmarmelis/kibridge/blob/main/plugin/kibridge/kibridge_api.py): `plugin/kibridge/kibridge_api.py`

### KiRouter app

- [HTTP API server](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/server.py): `router/kirouter/server.py`
- [Loaded board state](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/state.py): `router/kirouter/state.py`
- [Canvas web app](https://github.com/igmarmelis/kibridge/tree/main/router/kirouter/static): `router/kirouter/static`

### Routing and checks

- [Routing engine manager](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/router_engine/__init__.py): `router/kirouter/router_engine/__init__.py`
- [First-pass DRC](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/drc.py): `router/kirouter/drc.py`

### Freerouting adapter

- [DSN export](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/freerouting/dsn_export.py): `router/kirouter/freerouting/dsn_export.py`
- [Freerouting process](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/freerouting/runner.py): `router/kirouter/freerouting/runner.py`
- [SES result import](https://github.com/igmarmelis/kibridge/blob/main/router/kirouter/freerouting/ses_import.py): `router/kirouter/freerouting/ses_import.py`

### Other components

- **KiCad user**
- **Copilot**
- **Browser user**
- **KiCad board**

## Connections

- KiCad user → Toolbar actions: uses tools (evidence: `README.md`)
- Toolbar actions → Board inspection: dispatches inspection (evidence: `plugin/kibridge/action_plugin.py`)
- Board inspection → KiCad board: reads board (evidence: `plugin/kibridge/board_inspector.py`)
- Toolbar actions → Inspection reports: writes reports (evidence: `plugin/kibridge/action_plugin.py`)
- Toolbar actions → Open workspace: dispatches open (evidence: `plugin/kibridge/__init__.py`)
- Open workspace → Workspace export: creates snapshot (evidence: `plugin/kibridge/workspace_open.py`)
- Workspace export → Board inspection: uses inspection (evidence: `plugin/kibridge/workspace_exporter.py`)
- Copilot → Workspace suggestions: reviews snapshot (evidence: `README.md`)
- Toolbar actions → Apply suggestions: dispatches apply (evidence: `plugin/kibridge/__init__.py`)
- Apply suggestions → Validation and apply: invokes (evidence: `plugin/kibridge/workspace_apply.py`)
- Validation and apply → Script sandbox: runs scripts (evidence: `plugin/kibridge/workspace_applier.py`)
- Validation and apply → Safety checks: checks safety (evidence: `plugin/kibridge/workspace_applier.py`)
- Validation and apply → Board operations API: applies actions (evidence: `plugin/kibridge/workspace_applier.py`)
- Board operations API → KiCad board: modifies board (evidence: `README.md`)
- Toolbar actions → Send board: dispatches send (evidence: `plugin/kibridge/__init__.py`)
- Send board → HTTP board client: builds and posts (evidence: `plugin/kibridge/send_to_kirouter.py`)
- HTTP board client → HTTP API server: uploads JSON (evidence: `README.md`)
- HTTP API server → Loaded board state: stores board (evidence: `router/kirouter/server.py`)
- Browser user → Canvas web app: views and controls (evidence: `README.md`)
- Canvas web app → HTTP API server: calls API (evidence: `README.md`)
- HTTP API server → Routing engine manager: submits route (evidence: `router/kirouter/server.py`)
- HTTP API server → First-pass DRC: runs DRC (evidence: `router/kirouter/server.py`)
- Routing engine manager → DSN export: exports design (evidence: `README.md`)
- Routing engine manager → Freerouting process: runs subprocess (evidence: `README.md`)
- Routing engine manager → SES result import: parses session (evidence: `router/kirouter/router_engine/__init__.py`)
- HTTP API server → Loaded board state: reads board (evidence: `router/kirouter/server.py`)
- Toolbar actions → Import route result: dispatches import (evidence: `plugin/kibridge/__init__.py`)
- Import route result → HTTP board client: fetches route (evidence: `plugin/kibridge/import_from_kirouter.py`)
- HTTP board client → HTTP API server: gets result (evidence: `README.md`)
- Import route result → KiCad board: backs up and applies (evidence: `README.md`)
- Send board → Schema version: uses version (evidence: `plugin/kibridge/send_to_kirouter.py`)
