# appium/appium-inspector architecture

> Architecture diagram of the GitHub repository appium/appium-inspector, 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/appium/appium-inspector
- Repository: https://github.com/appium/appium-inspector

## Overview

Appium Inspector is a GUI for configuring or attaching to Appium sessions, then inspecting and interacting with the app under test. The main flow runs from session setup through the Appium session starter to the Inspector, whose capabilities include screenshots, source and locator inspection, commands, gestures, recording, and session details. The tree and README establish these product areas, but most of their implementation and runtime wiring were not sampled; those links are therefore omitted rather than inferred.

Main entry points: [`app/common/renderer/components/SessionInspector/SessionInspector.jsx`](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SessionInspector.jsx) (Inspector workspace), [`app/common/renderer/actions/SessionBuilder.js`](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/actions/SessionBuilder.js) (Session actions), [`app/common/renderer/actions/SessionInspector.js`](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/actions/SessionInspector.js) (Inspector actions), [`app/common/renderer/components/SessionBuilder/SessionBuilder.jsx`](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionBuilder/SessionBuilder.jsx) (Session builder)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Session setup"]
  node_builder["Session builder<br/>[SessionBuilder.jsx]"]
  node_builder_actions["Session actions<br/>[SessionBuilder.js]"]
  node_session_files["Session file parsing"]
  node_attach["Attach discovery"]
  node_server_config["Server providers"]
end

subgraph group_inspect["App inspection"]
  node_inspector["Inspector workspace"]
  node_inspector_actions["Inspector actions"]
  node_screenshot["Screenshot view<br/>[Screenshot.jsx]"]
  node_source_view["Source inspection<br/>[SourceTab.jsx]"]
  node_locator_search["Locator search"]
  node_commands["Command runner<br/>[Commands.jsx]"]
  node_gestures["Gesture editor<br/>[GestureEditor.jsx]"]
  node_recorder["Action recorder<br/>[Recorder.jsx]"]
  node_session_info["Session details<br/>[SessionInfo.jsx]"]
  node_client_frameworks["Code frameworks"]
end

subgraph group_runtime["Appium runtime"]
  node_session_starter["Session starter<br/>[session-starter.js]"]
  node_inspector_driver["Inspector driver"]
end

subgraph group_platform["Desktop platform"]
  node_desktop_main["Electron main<br/>[main.js]"]
  node_windows["Desktop windows<br/>[windows.js]"]
end

subgraph group_shared["Shared state"]
  node_inspector_state["Inspector state"]
  node_builder_state["Builder state<br/>[SessionBuilder.js]"]
  node_settings[("Persistent settings<br/>[setting-defs.js]")]
  node_renderer_helpers["Renderer utilities"]
end

node_user(("Inspector user"))
node_appium{{"Appium server"}}

node_user -->|"configures session"| node_builder
node_builder -->|"dispatches actions"| node_builder_actions
node_builder_actions -->|"starts session"| node_session_starter
node_builder_actions -->|"discovers sessions"| node_attach
node_builder -->|"selects provider"| node_server_config
node_builder_actions -->|"parses session files"| node_session_files
node_session_starter -.->|"creates session"| node_appium
node_user -->|"inspects app"| node_inspector
node_inspector -->|"dispatches actions"| node_inspector_actions
node_inspector_actions -->|"drives Appium"| node_inspector_driver
node_inspector -->|"shows screenshot"| node_screenshot
node_inspector -.->|"offers source tab"| node_source_view
node_inspector -.->|"offers locator search"| node_locator_search
node_inspector -.->|"offers commands"| node_commands
node_inspector -.->|"offers gestures"| node_gestures
node_inspector -.->|"offers recording"| node_recorder
node_inspector -.->|"shows session details"| node_session_info
node_inspector_actions -->|"uses code frameworks"| node_client_frameworks
node_inspector_actions -->|"uses utilities"| node_renderer_helpers
node_desktop_main -->|"creates window"| node_windows

click node_builder "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionBuilder/SessionBuilder.jsx"
click node_builder_actions "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/actions/SessionBuilder.js"
click node_session_files "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/utils/sessionfile-parsing.js"
click node_attach "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/utils/attaching-to-session.js"
click node_server_config "https://github.com/appium/appium-inspector/tree/main/app/common/renderer/components/SessionBuilder/ServerDetails"
click node_session_starter "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/lib/appium/session-starter.js"
click node_inspector "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SessionInspector.jsx"
click node_inspector_actions "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/actions/SessionInspector.js"
click node_inspector_driver "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/lib/appium/inspector-driver.js"
click node_screenshot "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/Screenshot/Screenshot.jsx"
click node_source_view "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SourceTab/SourceTab.jsx"
click node_locator_search "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/Header/LocatorSearch/LocatorSearchModal.jsx"
click node_commands "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/CommandsTab/Commands.jsx"
click node_gestures "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/GesturesTab/GestureEditor/GestureEditor.jsx"
click node_recorder "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/RecorderTab/Recorder.jsx"
click node_session_info "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SessionInfoTab/SessionInfo.jsx"
click node_client_frameworks "https://github.com/appium/appium-inspector/tree/main/app/common/renderer/lib/client-frameworks"
click node_inspector_state "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/reducers/SessionInspector.js"
click node_builder_state "https://github.com/appium/appium-inspector/blob/main/app/common/renderer/reducers/SessionBuilder.js"
click node_settings "https://github.com/appium/appium-inspector/blob/main/app/common/shared/setting-defs.js"
click node_renderer_helpers "https://github.com/appium/appium-inspector/tree/main/app/common/renderer/utils"
click node_desktop_main "https://github.com/appium/appium-inspector/blob/main/app/electron/main/main.js"
click node_windows "https://github.com/appium/appium-inspector/blob/main/app/electron/main/windows.js"

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_builder,node_builder_actions,node_session_files,node_attach,node_server_config,node_user toneBlue
class node_inspector,node_inspector_actions,node_screenshot,node_source_view,node_locator_search,node_commands,node_gestures,node_recorder,node_session_info,node_client_frameworks toneAmber
class node_session_starter,node_inspector_driver,node_appium toneMint
class node_desktop_main,node_windows toneRose
class node_inspector_state,node_builder_state,node_settings,node_renderer_helpers toneIndigo
```

## Components

### Session setup

- [Session builder](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionBuilder/SessionBuilder.jsx): `app/common/renderer/components/SessionBuilder/SessionBuilder.jsx`
- [Session actions](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/actions/SessionBuilder.js): `app/common/renderer/actions/SessionBuilder.js`
- [Session file parsing](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/utils/sessionfile-parsing.js): `app/common/renderer/utils/sessionfile-parsing.js`
- [Attach discovery](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/utils/attaching-to-session.js): `app/common/renderer/utils/attaching-to-session.js`
- [Server providers](https://github.com/appium/appium-inspector/tree/main/app/common/renderer/components/SessionBuilder/ServerDetails): `app/common/renderer/components/SessionBuilder/ServerDetails`

### App inspection

- [Inspector workspace](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SessionInspector.jsx): `app/common/renderer/components/SessionInspector/SessionInspector.jsx`
- [Inspector actions](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/actions/SessionInspector.js): `app/common/renderer/actions/SessionInspector.js`
- [Screenshot view](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/Screenshot/Screenshot.jsx): `app/common/renderer/components/SessionInspector/Screenshot/Screenshot.jsx`
- [Source inspection](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SourceTab/SourceTab.jsx): `app/common/renderer/components/SessionInspector/SourceTab/SourceTab.jsx`
- [Locator search](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/Header/LocatorSearch/LocatorSearchModal.jsx): `app/common/renderer/components/SessionInspector/Header/LocatorSearch/LocatorSearchModal.jsx`
- [Command runner](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/CommandsTab/Commands.jsx): `app/common/renderer/components/SessionInspector/CommandsTab/Commands.jsx`
- [Gesture editor](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/GesturesTab/GestureEditor/GestureEditor.jsx): `app/common/renderer/components/SessionInspector/GesturesTab/GestureEditor/GestureEditor.jsx`
- [Action recorder](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/RecorderTab/Recorder.jsx): `app/common/renderer/components/SessionInspector/RecorderTab/Recorder.jsx`
- [Session details](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/components/SessionInspector/SessionInfoTab/SessionInfo.jsx): `app/common/renderer/components/SessionInspector/SessionInfoTab/SessionInfo.jsx`
- [Code frameworks](https://github.com/appium/appium-inspector/tree/main/app/common/renderer/lib/client-frameworks): `app/common/renderer/lib/client-frameworks`

### Appium runtime

- [Session starter](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/lib/appium/session-starter.js): `app/common/renderer/lib/appium/session-starter.js`
- [Inspector driver](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/lib/appium/inspector-driver.js): `app/common/renderer/lib/appium/inspector-driver.js`

### Desktop platform

- [Electron main](https://github.com/appium/appium-inspector/blob/main/app/electron/main/main.js): `app/electron/main/main.js`
- [Desktop windows](https://github.com/appium/appium-inspector/blob/main/app/electron/main/windows.js): `app/electron/main/windows.js`

### Shared state

- [Inspector state](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/reducers/SessionInspector.js): `app/common/renderer/reducers/SessionInspector.js`
- [Builder state](https://github.com/appium/appium-inspector/blob/main/app/common/renderer/reducers/SessionBuilder.js): `app/common/renderer/reducers/SessionBuilder.js`
- [Persistent settings](https://github.com/appium/appium-inspector/blob/main/app/common/shared/setting-defs.js): `app/common/shared/setting-defs.js`
- [Renderer utilities](https://github.com/appium/appium-inspector/tree/main/app/common/renderer/utils): `app/common/renderer/utils`

### Other components

- **Inspector user**
- **Appium server**

## Connections

- Inspector user → Session builder: configures session (evidence: `README.md`)
- Session builder → Session actions: dispatches actions (evidence: `app/common/renderer/components/SessionBuilder/SessionBuilder.jsx`)
- Session actions → Session starter: starts session (evidence: `app/common/renderer/actions/SessionBuilder.js`)
- Session actions → Attach discovery: discovers sessions (evidence: `app/common/renderer/actions/SessionBuilder.js`)
- Session builder → Server providers: selects provider (evidence: `app/common/renderer/components/SessionBuilder/SessionBuilder.jsx`)
- Session actions → Session file parsing: parses session files (evidence: `app/common/renderer/actions/SessionBuilder.js`)
- Session starter → Appium server: creates session
- Inspector user → Inspector workspace: inspects app (evidence: `README.md`)
- Inspector workspace → Inspector actions: dispatches actions (evidence: `app/common/renderer/components/SessionInspector/SessionInspector.jsx`)
- Inspector actions → Inspector driver: drives Appium (evidence: `app/common/renderer/actions/SessionInspector.js`)
- Inspector workspace → Screenshot view: shows screenshot (evidence: `app/common/renderer/components/SessionInspector/SessionInspector.jsx`)
- Inspector workspace → Source inspection: offers source tab
- Inspector workspace → Locator search: offers locator search
- Inspector workspace → Command runner: offers commands
- Inspector workspace → Gesture editor: offers gestures
- Inspector workspace → Action recorder: offers recording
- Inspector workspace → Session details: shows session details
- Inspector actions → Code frameworks: uses code frameworks (evidence: `app/common/renderer/actions/SessionInspector.js`)
- Inspector actions → Renderer utilities: uses utilities (evidence: `app/common/renderer/actions/SessionInspector.js`)
- Electron main → Desktop windows: creates window (evidence: `app/electron/main/main.js`)
