# sknampally/reframe architecture

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

- Interactive diagram: https://gitdiagram.com/sknampally/reframe
- Repository: https://github.com/sknampally/reframe

## Overview

Reframe is a workstation CLI that prepares evidence-backed mainframe modernization plans; it does not translate or deploy production applications. The principal flow pins source, runs an AWS Transform assessment, pauses for human approval, optionally performs executor/reviewer validation, then produces wireframe drafts and handoff packages. The graph also includes saved-workspace, guided-console, optional-context, and local pilot capabilities. Some relationships are supported only by README descriptions or SOURCE INDEX references; unsampled implementation details are not inferred.

Main entry points: [`scripts/reframe.py`](https://github.com/sknampally/reframe/blob/main/scripts/reframe.py) (Reframe CLI), [`scripts/reframe_preview.py`](https://github.com/sknampally/reframe/blob/main/scripts/reframe_preview.py) (Wireframe preview), [`scripts/reframe_terminal.py`](https://github.com/sknampally/reframe/blob/main/scripts/reframe_terminal.py) (Terminal console), [`scripts/reframe_flow.py`](https://github.com/sknampally/reframe/blob/main/scripts/reframe_flow.py) (Guided flow)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_guided["Guided workflow"]
  node_cli["Reframe CLI<br/>[reframe.py]"]
  node_console["Terminal console"]
  node_flow["Guided flow<br/>[reframe_flow.py]"]
  node_setup["Guided setup<br/>[reframe_setup.py]"]
end

subgraph group_assessment["Source assessment"]
  node_source["Pinned source<br/>[reframe_source.py]"]
  node_transform["AWS Transform"]
  node_transport["Transform workflow<br/>[kiro_workflow.py]"]
end

subgraph group_review["Review and design"]
  node_checkpoints["Review checkpoints"]
  node_executor["Executor agent"]
  node_reviewer["Independent reviewer"]
  node_preview["Wireframe preview<br/>[reframe_preview.py]"]
  node_optional["Optional design modes"]
end

subgraph group_state["Workspace and handoff"]
  node_artifacts["Spec validation"]
  node_handoff["AI-DLC handoff<br/>[reframe_handoff.py]"]
  node_workspace[("Workspace storage")]
  node_projects[("Project index")]
  node_contracts["Record contracts"]
  node_models["Workflow models<br/>[reframe_models.py]"]
  node_pilot["Local pilot workflow<br/>[pilot.py]"]
  node_offline["Offline demo<br/>[reframe_offline.py]"]
end

node_person(("Project team"))

node_person -->|"starts and guides"| node_console
node_console -->|"guides through"| node_flow
node_flow -->|"invokes operations"| node_cli
node_cli -->|"delegates setup"| node_setup
node_cli -->|"pins source"| node_source
node_cli -->|"runs assessment"| node_transport
node_transport -->|"uploads and assesses"| node_transform
node_transform -->|"returns findings"| node_cli
node_person -->|"approves phases"| node_cli
node_cli -->|"manages review"| node_checkpoints
node_cli -->|"requests specification"| node_executor
node_cli -->|"requests independent review"| node_reviewer
node_reviewer -->|"returns verdict"| node_cli
node_cli -->|"creates preview"| node_preview
node_preview -->|"writes draft files"| node_workspace
node_cli -->|"dispatches optional modes"| node_optional
node_optional -->|"uses preview inputs"| node_preview
node_cli -->|"validates artifacts"| node_artifacts
node_cli -->|"builds handoff"| node_handoff
node_cli -->|"saves project state"| node_workspace
node_cli -->|"indexes workspaces"| node_projects
node_cli -->|"checks records"| node_contracts
node_cli -->|"uses workflow models"| node_models
node_person -->|"runs local pilot"| node_pilot
node_person -->|"runs simulated demo"| node_offline

click node_cli "https://github.com/sknampally/reframe/blob/main/scripts/reframe.py"
click node_console "https://github.com/sknampally/reframe/blob/main/scripts/reframe_terminal.py"
click node_flow "https://github.com/sknampally/reframe/blob/main/scripts/reframe_flow.py"
click node_setup "https://github.com/sknampally/reframe/blob/main/scripts/reframe_setup.py"
click node_source "https://github.com/sknampally/reframe/blob/main/scripts/reframe_source.py"
click node_transport "https://github.com/sknampally/reframe/blob/main/scripts/kiro_workflow.py"
click node_checkpoints "https://github.com/sknampally/reframe/blob/main/scripts/reframe_checkpoints.py"
click node_preview "https://github.com/sknampally/reframe/blob/main/scripts/reframe_preview.py"
click node_optional "https://github.com/sknampally/reframe/blob/main/scripts/reframe_optional.py"
click node_artifacts "https://github.com/sknampally/reframe/blob/main/scripts/reframe_artifacts.py"
click node_handoff "https://github.com/sknampally/reframe/blob/main/scripts/reframe_handoff.py"
click node_workspace "https://github.com/sknampally/reframe/blob/main/scripts/reframe_workspace.py"
click node_projects "https://github.com/sknampally/reframe/blob/main/scripts/reframe_projects.py"
click node_contracts "https://github.com/sknampally/reframe/blob/main/scripts/reframe_contracts.py"
click node_models "https://github.com/sknampally/reframe/blob/main/scripts/reframe_models.py"
click node_pilot "https://github.com/sknampally/reframe/blob/main/scripts/pilot.py"
click node_offline "https://github.com/sknampally/reframe/blob/main/scripts/reframe_offline.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_cli,node_console,node_flow,node_setup toneBlue
class node_source,node_transform,node_transport toneAmber
class node_checkpoints,node_executor,node_reviewer,node_preview,node_optional toneMint
class node_artifacts,node_handoff,node_workspace,node_projects,node_contracts,node_models,node_pilot,node_offline toneRose
class node_person toneIndigo
```

## Components

### Guided workflow

- [Reframe CLI](https://github.com/sknampally/reframe/blob/main/scripts/reframe.py): `scripts/reframe.py`
- [Terminal console](https://github.com/sknampally/reframe/blob/main/scripts/reframe_terminal.py): `scripts/reframe_terminal.py`
- [Guided flow](https://github.com/sknampally/reframe/blob/main/scripts/reframe_flow.py): `scripts/reframe_flow.py`
- [Guided setup](https://github.com/sknampally/reframe/blob/main/scripts/reframe_setup.py): `scripts/reframe_setup.py`

### Source assessment

- [Pinned source](https://github.com/sknampally/reframe/blob/main/scripts/reframe_source.py): `scripts/reframe_source.py`
- **AWS Transform**
- [Transform workflow](https://github.com/sknampally/reframe/blob/main/scripts/kiro_workflow.py): `scripts/kiro_workflow.py`

### Review and design

- [Review checkpoints](https://github.com/sknampally/reframe/blob/main/scripts/reframe_checkpoints.py): `scripts/reframe_checkpoints.py`
- **Executor agent**
- **Independent reviewer**
- [Wireframe preview](https://github.com/sknampally/reframe/blob/main/scripts/reframe_preview.py): `scripts/reframe_preview.py`
- [Optional design modes](https://github.com/sknampally/reframe/blob/main/scripts/reframe_optional.py): `scripts/reframe_optional.py`

### Workspace and handoff

- [Spec validation](https://github.com/sknampally/reframe/blob/main/scripts/reframe_artifacts.py): `scripts/reframe_artifacts.py`
- [AI-DLC handoff](https://github.com/sknampally/reframe/blob/main/scripts/reframe_handoff.py): `scripts/reframe_handoff.py`
- [Workspace storage](https://github.com/sknampally/reframe/blob/main/scripts/reframe_workspace.py): `scripts/reframe_workspace.py`
- [Project index](https://github.com/sknampally/reframe/blob/main/scripts/reframe_projects.py): `scripts/reframe_projects.py`
- [Record contracts](https://github.com/sknampally/reframe/blob/main/scripts/reframe_contracts.py): `scripts/reframe_contracts.py`
- [Workflow models](https://github.com/sknampally/reframe/blob/main/scripts/reframe_models.py): `scripts/reframe_models.py`
- [Local pilot workflow](https://github.com/sknampally/reframe/blob/main/scripts/pilot.py): `scripts/pilot.py`
- [Offline demo](https://github.com/sknampally/reframe/blob/main/scripts/reframe_offline.py): `scripts/reframe_offline.py`

### Other components

- **Project team**

## Connections

- Project team → Terminal console: starts and guides (evidence: `README.md`)
- Terminal console → Guided flow: guides through (evidence: `scripts/reframe_terminal.py`)
- Guided flow → Reframe CLI: invokes operations (evidence: `scripts/reframe_flow.py`)
- Reframe CLI → Guided setup: delegates setup (evidence: `scripts/reframe.py`)
- Reframe CLI → Pinned source: pins source (evidence: `scripts/reframe.py`)
- Reframe CLI → Transform workflow: runs assessment (evidence: `scripts/reframe.py`)
- Transform workflow → AWS Transform: uploads and assesses (evidence: `README.md`)
- AWS Transform → Reframe CLI: returns findings (evidence: `README.md`)
- Project team → Reframe CLI: approves phases (evidence: `README.md`)
- Reframe CLI → Review checkpoints: manages review (evidence: `scripts/reframe.py`)
- Reframe CLI → Executor agent: requests specification (evidence: `README.md`)
- Reframe CLI → Independent reviewer: requests independent review (evidence: `README.md`)
- Independent reviewer → Reframe CLI: returns verdict (evidence: `README.md`)
- Reframe CLI → Wireframe preview: creates preview (evidence: `scripts/reframe.py`)
- Wireframe preview → Workspace storage: writes draft files (evidence: `scripts/reframe_preview.py`)
- Reframe CLI → Optional design modes: dispatches optional modes (evidence: `scripts/reframe.py`)
- Optional design modes → Wireframe preview: uses preview inputs (evidence: `scripts/reframe_optional.py`)
- Reframe CLI → Spec validation: validates artifacts (evidence: `scripts/reframe.py`)
- Reframe CLI → AI-DLC handoff: builds handoff (evidence: `scripts/reframe.py`)
- Reframe CLI → Workspace storage: saves project state (evidence: `scripts/reframe.py`)
- Reframe CLI → Project index: indexes workspaces (evidence: `scripts/reframe.py`)
- Reframe CLI → Record contracts: checks records (evidence: `scripts/reframe.py`)
- Reframe CLI → Workflow models: uses workflow models (evidence: `scripts/reframe.py`)
- Project team → Local pilot workflow: runs local pilot (evidence: `README.md`)
- Project team → Offline demo: runs simulated demo (evidence: `README.md`)
