# elc0mpa/aws-doctor architecture

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

- Interactive diagram: https://gitdiagram.com/elc0mpa/aws-doctor
- Repository: https://github.com/elc0mpa/aws-doctor

## Overview

aws-doctor is a terminal AWS account health checker for cost comparisons, spending trends, and waste discovery, with table/JSON/CSV output and PDF reports. The principal workflow is CLI invocation, AWS configuration, analysis against AWS APIs, then rendered results or a report. Waste analysis also supports selected checks and interactive navigation. The source index and sampled excerpts establish several service dependencies; other documented capabilities are retained where their internal wiring was not sampled, so those links are marked unverified or omitted.

Main entry points: [`service/orchestrator`](https://github.com/elc0mpa/aws-doctor/tree/main/service/orchestrator) (Workflow orchestrator), [`cmd/root.go`](https://github.com/elc0mpa/aws-doctor/blob/main/cmd/root.go) (CLI commands), [`service/pricing/service.go`](https://github.com/elc0mpa/aws-doctor/blob/main/service/pricing/service.go) (Regional pricing), [`service/report/service_waste.go`](https://github.com/elc0mpa/aws-doctor/blob/main/service/report/service_waste.go) (PDF reports)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and orchestration"]
  node_cli["CLI commands<br/>[root.go]"]
  node_orchestrator["Workflow orchestrator"]
  node_registry["Analyzer registry<br/>[registry.go]"]
end

subgraph group_analysis["Cost and analysis"]
  node_cost["Cost Explorer<br/>[service.go]"]
  node_pricing["Regional pricing<br/>[service.go]"]
end

subgraph group_cloud["AWS resource checks"]
  node_ec2["EC2 checks<br/>[service.go]"]
  node_s3["S3 checks<br/>[service.go]"]
  node_rds["RDS checks<br/>[service.go]"]
  node_vpc["VPC checks<br/>[service.go]"]
  node_lambda["Lambda checks<br/>[service.go]"]
  node_logs["CloudWatch Logs<br/>[service.go]"]
  node_metrics["CloudWatch metrics<br/>[service.go]"]
  node_sagemaker["SageMaker checks<br/>[service.go]"]
  node_iam["IAM checks<br/>[service.go]"]
  node_ecr["ECR checks<br/>[service.go]"]
  node_elb["Load balancer checks<br/>[service.go]"]
end

subgraph group_presentation["Results and reports"]
  node_renderer["Terminal and data output<br/>[service.go]"]
  node_json["JSON presentation<br/>[json_output.go]"]
  node_tui["Interactive waste UI<br/>[waste_model.go]"]
  node_report["PDF reports<br/>[service_waste.go]"]
end

subgraph group_support["Account support"]
  node_config["AWS configuration<br/>[service.go]"]
  node_cache[("Local cache<br/>[service.go]")]
  node_updates["Update notifications<br/>[service.go]"]
end

node_user(("Terminal user"))
node_aws{{"AWS APIs"}}

node_user -->|"runs command"| node_cli
node_cli -->|"loads credentials"| node_config
node_cli -->|"dispatches workflow"| node_orchestrator
node_cli -->|"configures rates"| node_pricing
node_orchestrator -.->|"requests cost data"| node_cost
node_orchestrator -.->|"selects checks"| node_registry
node_cost -.->|"queries costs"| node_aws
node_pricing -.->|"loads rates"| node_aws
node_ec2 -.->|"scans resources"| node_aws
node_s3 -.->|"scans resources"| node_aws
node_rds -.->|"scans resources"| node_aws
node_vpc -.->|"scans resources"| node_aws
node_lambda -.->|"scans functions"| node_aws
node_lambda -->|"queries usage"| node_logs
node_logs -.->|"queries logs"| node_aws
node_sagemaker -->|"checks invocations"| node_metrics
node_sagemaker -.->|"estimates cost"| node_pricing
node_iam -.->|"checks identity"| node_aws
node_ecr -.->|"scans repositories"| node_aws
node_elb -.->|"scans load balancers"| node_aws
node_orchestrator -->|"renders results"| node_renderer
node_orchestrator -->|"generates report"| node_report
node_report -->|"uses rate estimates"| node_pricing
node_report -->|"uses presenters"| node_json
node_renderer -.->|"offers interactive view"| node_tui
node_orchestrator -.->|"uses cached data"| node_cache
node_cli -.->|"checks versions"| node_updates
node_updates -->|"caches check"| node_cache

click node_cli "https://github.com/elc0mpa/aws-doctor/blob/main/cmd/root.go"
click node_config "https://github.com/elc0mpa/aws-doctor/blob/main/service/aws_config/service.go"
click node_orchestrator "https://github.com/elc0mpa/aws-doctor/tree/main/service/orchestrator"
click node_registry "https://github.com/elc0mpa/aws-doctor/blob/main/service/analyzer/registry.go"
click node_cost "https://github.com/elc0mpa/aws-doctor/blob/main/service/costexplorer/service.go"
click node_pricing "https://github.com/elc0mpa/aws-doctor/blob/main/service/pricing/service.go"
click node_ec2 "https://github.com/elc0mpa/aws-doctor/blob/main/service/ec2/service.go"
click node_s3 "https://github.com/elc0mpa/aws-doctor/blob/main/service/s3/service.go"
click node_rds "https://github.com/elc0mpa/aws-doctor/blob/main/service/rds/service.go"
click node_vpc "https://github.com/elc0mpa/aws-doctor/blob/main/service/vpc/service.go"
click node_lambda "https://github.com/elc0mpa/aws-doctor/blob/main/service/lambda/service.go"
click node_logs "https://github.com/elc0mpa/aws-doctor/blob/main/service/cloudwatchlogs/service.go"
click node_metrics "https://github.com/elc0mpa/aws-doctor/blob/main/service/cloudwatchmetrics/service.go"
click node_sagemaker "https://github.com/elc0mpa/aws-doctor/blob/main/service/sagemaker/service.go"
click node_iam "https://github.com/elc0mpa/aws-doctor/blob/main/service/iam/service.go"
click node_ecr "https://github.com/elc0mpa/aws-doctor/blob/main/service/ecr/service.go"
click node_elb "https://github.com/elc0mpa/aws-doctor/blob/main/service/elb/service.go"
click node_renderer "https://github.com/elc0mpa/aws-doctor/blob/main/service/output/service.go"
click node_json "https://github.com/elc0mpa/aws-doctor/blob/main/utils/json_output/json_output.go"
click node_tui "https://github.com/elc0mpa/aws-doctor/blob/main/utils/tui/waste_model.go"
click node_report "https://github.com/elc0mpa/aws-doctor/blob/main/service/report/service_waste.go"
click node_cache "https://github.com/elc0mpa/aws-doctor/blob/main/service/cache/service.go"
click node_updates "https://github.com/elc0mpa/aws-doctor/blob/main/service/update/service.go"

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_orchestrator,node_registry,node_user toneBlue
class node_cost,node_pricing toneAmber
class node_ec2,node_s3,node_rds,node_vpc,node_lambda,node_logs,node_metrics,node_sagemaker,node_iam,node_ecr,node_elb,node_aws toneMint
class node_renderer,node_json,node_tui,node_report toneRose
class node_config,node_cache,node_updates toneIndigo
```

## Components

### CLI and orchestration

- [CLI commands](https://github.com/elc0mpa/aws-doctor/blob/main/cmd/root.go): `cmd/root.go`
- [Workflow orchestrator](https://github.com/elc0mpa/aws-doctor/tree/main/service/orchestrator): `service/orchestrator`
- [Analyzer registry](https://github.com/elc0mpa/aws-doctor/blob/main/service/analyzer/registry.go): `service/analyzer/registry.go`

### Cost and analysis

- [Cost Explorer](https://github.com/elc0mpa/aws-doctor/blob/main/service/costexplorer/service.go): `service/costexplorer/service.go`
- [Regional pricing](https://github.com/elc0mpa/aws-doctor/blob/main/service/pricing/service.go): `service/pricing/service.go`

### AWS resource checks

- [EC2 checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/ec2/service.go): `service/ec2/service.go`
- [S3 checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/s3/service.go): `service/s3/service.go`
- [RDS checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/rds/service.go): `service/rds/service.go`
- [VPC checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/vpc/service.go): `service/vpc/service.go`
- [Lambda checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/lambda/service.go): `service/lambda/service.go`
- [CloudWatch Logs](https://github.com/elc0mpa/aws-doctor/blob/main/service/cloudwatchlogs/service.go): `service/cloudwatchlogs/service.go`
- [CloudWatch metrics](https://github.com/elc0mpa/aws-doctor/blob/main/service/cloudwatchmetrics/service.go): `service/cloudwatchmetrics/service.go`
- [SageMaker checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/sagemaker/service.go): `service/sagemaker/service.go`
- [IAM checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/iam/service.go): `service/iam/service.go`
- [ECR checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/ecr/service.go): `service/ecr/service.go`
- [Load balancer checks](https://github.com/elc0mpa/aws-doctor/blob/main/service/elb/service.go): `service/elb/service.go`

### Results and reports

- [Terminal and data output](https://github.com/elc0mpa/aws-doctor/blob/main/service/output/service.go): `service/output/service.go`
- [JSON presentation](https://github.com/elc0mpa/aws-doctor/blob/main/utils/json_output/json_output.go): `utils/json_output/json_output.go`
- [Interactive waste UI](https://github.com/elc0mpa/aws-doctor/blob/main/utils/tui/waste_model.go): `utils/tui/waste_model.go`
- [PDF reports](https://github.com/elc0mpa/aws-doctor/blob/main/service/report/service_waste.go): `service/report/service_waste.go`

### Account support

- [AWS configuration](https://github.com/elc0mpa/aws-doctor/blob/main/service/aws_config/service.go): `service/aws_config/service.go`
- [Local cache](https://github.com/elc0mpa/aws-doctor/blob/main/service/cache/service.go): `service/cache/service.go`
- [Update notifications](https://github.com/elc0mpa/aws-doctor/blob/main/service/update/service.go): `service/update/service.go`

### Other components

- **Terminal user**
- **AWS APIs**

## Connections

- Terminal user → CLI commands: runs command (evidence: `README.md`)
- CLI commands → AWS configuration: loads credentials (evidence: `cmd/root.go`)
- CLI commands → Workflow orchestrator: dispatches workflow (evidence: `cmd/root.go`)
- CLI commands → Regional pricing: configures rates (evidence: `cmd/root.go`)
- Workflow orchestrator → Cost Explorer: requests cost data
- Workflow orchestrator → Analyzer registry: selects checks
- Cost Explorer → AWS APIs: queries costs
- Regional pricing → AWS APIs: loads rates
- EC2 checks → AWS APIs: scans resources
- S3 checks → AWS APIs: scans resources
- RDS checks → AWS APIs: scans resources
- VPC checks → AWS APIs: scans resources
- Lambda checks → AWS APIs: scans functions
- Lambda checks → CloudWatch Logs: queries usage (evidence: `service/lambda/service.go`)
- CloudWatch Logs → AWS APIs: queries logs
- SageMaker checks → CloudWatch metrics: checks invocations (evidence: `service/sagemaker/service.go`)
- SageMaker checks → Regional pricing: estimates cost
- IAM checks → AWS APIs: checks identity
- ECR checks → AWS APIs: scans repositories
- Load balancer checks → AWS APIs: scans load balancers
- Workflow orchestrator → Terminal and data output: renders results (evidence: `service/orchestrator/service_waste.go`)
- Workflow orchestrator → PDF reports: generates report (evidence: `service/orchestrator/service_waste.go`)
- PDF reports → Regional pricing: uses rate estimates (evidence: `service/report/service_waste.go`)
- PDF reports → JSON presentation: uses presenters (evidence: `service/report/service_waste.go`)
- Terminal and data output → Interactive waste UI: offers interactive view
- Workflow orchestrator → Local cache: uses cached data
- CLI commands → Update notifications: checks versions
- Update notifications → Local cache: caches check (evidence: `service/update/service.go`)
