# erwindon/saltgui architecture

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

- Interactive diagram: https://gitdiagram.com/erwindon/saltgui
- Repository: https://github.com/erwindon/saltgui

## Overview

SaltGUI is a single-page browser interface for managing Salt servers and minions through salt-api, with no application database. The principal workflow is navigation to a management view, issuing or selecting an operation, sending it through the API, and presenting the response. The graph preserves major documented areas—minions, jobs, highstate, issues, inventory data, events, orchestration, and command help—while grouping related views. Some subsystem links are documentation-based or unverified because their implementation excerpts were not provided.

Main entry points: [`saltgui/static/scripts/CommandBox.js`](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/CommandBox.js) (Command interface), [`saltgui/static/scripts/panels`](https://github.com/erwindon/saltgui/tree/master/saltgui/static/scripts/panels) (Management panels), [`saltgui/static/scripts/pages`](https://github.com/erwindon/saltgui/tree/master/saltgui/static/scripts/pages) (Management pages), [`saltgui/static/scripts/Router.js`](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Router.js) (Page router)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_navigation["Navigation"]
  node_router["Page router<br/>[Router.js]"]
  node_pages["Management pages"]
  node_pagebase["Page framework<br/>[Page.js]"]
end

subgraph group_operations["Commands and API"]
  node_commandbox["Command interface<br/>[CommandBox.js]"]
  node_api["Salt API client<br/>[Api.js]"]
  node_commandparse["Command parsing"]
  node_targettype["Target selection<br/>[TargetType.js]"]
  node_templates["Command templates<br/>[Templates.js]"]
end

subgraph group_management["Salt management"]
  node_panels["Management panels"]
  node_issues["Issue analysis<br/>[Issues.js]"]
  node_jobsummary["Recent jobs<br/>[JobsSummary.js]"]
  node_keys["Key management<br/>[Keys.js]"]
  node_minions["Minion inventory<br/>[Minions.js]"]
  node_orchestration["Orchestrations<br/>[Orchestrations.js]"]
end

subgraph group_presentation["Results and help"]
  node_output["Output formatting<br/>[Output.js]"]
  node_nested["Nested output<br/>[OutputNested.js]"]
  node_documentation["Command documentation<br/>[Documentation.js]"]
end

node_operator(("Operator"))
node_saltapi{{"salt-api"}}
node_salt{{"Salt server and minions"}}

node_operator -->|"navigates"| node_router
node_router -->|"registers views"| node_pages
node_pages -->|"extends"| node_pagebase
node_pagebase -->|"opens commands"| node_commandbox
node_operator -.->|"runs commands"| node_commandbox
node_commandbox -.->|"parses input"| node_commandparse
node_commandbox -.->|"selects targets"| node_targettype
node_commandbox -.->|"applies templates"| node_templates
node_commandbox -.->|"submits requests"| node_api
node_api -.->|"calls"| node_saltapi
node_saltapi -->|"manages"| node_salt
node_pages -.->|"assembles views"| node_panels
node_panels -.->|"shows issues"| node_issues
node_panels -.->|"shows recent jobs"| node_jobsummary
node_panels -.->|"manages keys"| node_keys
node_panels -.->|"shows minions"| node_minions
node_panels -.->|"starts workflows"| node_orchestration
node_commandbox -->|"displays results"| node_output
node_output -->|"formats nested data"| node_nested
node_commandbox -.->|"shows help"| node_documentation

click node_router "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Router.js"
click node_pages "https://github.com/erwindon/saltgui/tree/master/saltgui/static/scripts/pages"
click node_pagebase "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/pages/Page.js"
click node_panels "https://github.com/erwindon/saltgui/tree/master/saltgui/static/scripts/panels"
click node_commandbox "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/CommandBox.js"
click node_api "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Api.js"
click node_commandparse "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/ParseCommandLine.js"
click node_targettype "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/TargetType.js"
click node_templates "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Templates.js"
click node_issues "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/issues/Issues.js"
click node_jobsummary "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/JobsSummary.js"
click node_keys "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Keys.js"
click node_minions "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Minions.js"
click node_orchestration "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Orchestrations.js"
click node_output "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/output/Output.js"
click node_nested "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/output/OutputNested.js"
click node_documentation "https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Documentation.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_router,node_pages,node_pagebase toneBlue
class node_commandbox,node_api,node_commandparse,node_targettype,node_templates toneAmber
class node_panels,node_issues,node_jobsummary,node_keys,node_minions,node_orchestration,node_saltapi,node_salt toneMint
class node_output,node_nested,node_documentation toneRose
class node_operator toneIndigo
```

## Components

### Navigation

- [Page router](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Router.js): `saltgui/static/scripts/Router.js`
- [Management pages](https://github.com/erwindon/saltgui/tree/master/saltgui/static/scripts/pages): `saltgui/static/scripts/pages`
- [Page framework](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/pages/Page.js): `saltgui/static/scripts/pages/Page.js`

### Commands and API

- [Command interface](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/CommandBox.js): `saltgui/static/scripts/CommandBox.js`
- [Salt API client](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Api.js): `saltgui/static/scripts/Api.js`
- [Command parsing](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/ParseCommandLine.js): `saltgui/static/scripts/ParseCommandLine.js`
- [Target selection](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/TargetType.js): `saltgui/static/scripts/TargetType.js`
- [Command templates](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Templates.js): `saltgui/static/scripts/panels/Templates.js`

### Salt management

- [Management panels](https://github.com/erwindon/saltgui/tree/master/saltgui/static/scripts/panels): `saltgui/static/scripts/panels`
- [Issue analysis](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/issues/Issues.js): `saltgui/static/scripts/issues/Issues.js`
- [Recent jobs](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/JobsSummary.js): `saltgui/static/scripts/panels/JobsSummary.js`
- [Key management](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Keys.js): `saltgui/static/scripts/panels/Keys.js`
- [Minion inventory](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Minions.js): `saltgui/static/scripts/panels/Minions.js`
- [Orchestrations](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/panels/Orchestrations.js): `saltgui/static/scripts/panels/Orchestrations.js`

### Results and help

- [Output formatting](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/output/Output.js): `saltgui/static/scripts/output/Output.js`
- [Nested output](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/output/OutputNested.js): `saltgui/static/scripts/output/OutputNested.js`
- [Command documentation](https://github.com/erwindon/saltgui/blob/master/saltgui/static/scripts/Documentation.js): `saltgui/static/scripts/Documentation.js`

### Other components

- **Operator**
- **salt-api**
- **Salt server and minions**

## Connections

- Operator → Page router: navigates (evidence: `saltgui/static/scripts/Router.js`)
- Page router → Management pages: registers views (evidence: `saltgui/static/scripts/Router.js`)
- Management pages → Page framework: extends (evidence: `saltgui/static/scripts/pages/Orchestrations.js`)
- Page framework → Command interface: opens commands (evidence: `saltgui/static/scripts/pages/Page.js`)
- Operator → Command interface: runs commands
- Command interface → Command parsing: parses input (evidence: `saltgui/static/scripts/CommandBox.js`)
- Command interface → Target selection: selects targets (evidence: `saltgui/static/scripts/CommandBox.js`)
- Command interface → Command templates: applies templates (evidence: `saltgui/static/scripts/CommandBox.js`)
- Command interface → Salt API client: submits requests (evidence: `saltgui/static/scripts/Api.js`)
- Salt API client → salt-api: calls
- salt-api → Salt server and minions: manages
- Management pages → Management panels: assembles views (evidence: `saltgui/static/scripts/pages/Orchestrations.js`)
- Management panels → Issue analysis: shows issues
- Management panels → Recent jobs: shows recent jobs
- Management panels → Key management: manages keys (evidence: `saltgui/static/scripts/panels/Keys.js`)
- Management panels → Minion inventory: shows minions (evidence: `saltgui/static/scripts/panels/Minions.js`)
- Management panels → Orchestrations: starts workflows (evidence: `saltgui/static/scripts/panels/Orchestrations.js`)
- Command interface → Output formatting: displays results (evidence: `saltgui/static/scripts/CommandBox.js`)
- Output formatting → Nested output: formats nested data (evidence: `saltgui/static/scripts/output/Output.js`)
- Command interface → Command documentation: shows help (evidence: `saltgui/static/scripts/CommandBox.js`)
