# gmeghnag/koff architecture

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

## Overview

koff is a CLI for selecting Kubernetes YAML/JSON files or etcd snapshots, filtering resources with get arguments, and rendering tabular, YAML, or JSON output. The main path runs from the CLI into get, which handles resource objects and relies on helpers, deserialization, and table generation. The README also documents context selection with use and binary upgrades. Source excerpts do not fully expose input loading or etcd decoding, so those links are shown only where documented or left unverified.

Main entry points: [`cmd/get/get.go`](https://github.com/gmeghnag/koff/blob/main/cmd/get/get.go) (Resource Get), [`cmd/koff.go`](https://github.com/gmeghnag/koff/blob/main/cmd/koff.go) (Root Commands), [`cmd/use.go`](https://github.com/gmeghnag/koff/blob/main/cmd/use.go) (Input Context), [`cmd/upgrade/upgrade.go`](https://github.com/gmeghnag/koff/blob/main/cmd/upgrade/upgrade.go) (Upgrade Command)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI and Context"]
  node_entry["Program Entry<br/>[main.go]"]
  node_commands["Root Commands<br/>[koff.go]"]
  node_context["Input Context<br/>[use.go]"]
  node_config["Saved Context<br/>[use.go]"]
end

subgraph group_processing["Resource Processing"]
  node_get["Resource Get<br/>[get.go]"]
  node_resource_helpers["Resource Helpers<br/>[helpers.go]"]
  node_deserializer["Manifest Decoder<br/>[deserializer.go]"]
  node_etcd["Etcd Snapshot Reader<br/>[encoding.go]"]
  node_resource_types["Resource Types<br/>[know-types.go]"]
  node_shared_helpers["Data Helpers<br/>[helpers.go]"]
end

subgraph group_output["Output Rendering"]
  node_tablegen["Table Generator<br/>[tablegenerator.go]"]
  node_result["Rendered Results<br/>[koff.go]"]
  node_stdout(("Terminal Output"))
end

subgraph group_maintenance["Tool Maintenance"]
  node_upgrade["Upgrade Command<br/>[upgrade.go]"]
  node_release_service["Release Service"]
end

node_user(("CLI User"))

node_user -->|"runs"| node_entry
node_entry -->|"executes"| node_commands
node_commands -->|"registers"| node_get
node_commands -->|"registers"| node_context
node_commands -->|"registers"| node_upgrade
node_user -->|"selects input"| node_context
node_context -->|"writes context"| node_config
node_config -.->|"provides input"| node_get
node_get -->|"resolves resources"| node_resource_helpers
node_get -->|"decodes input"| node_deserializer
node_get -->|"uses resource types"| node_resource_types
node_get -->|"uses helpers"| node_shared_helpers
node_get -->|"builds tables"| node_tablegen
node_get -.->|"reads snapshot"| node_etcd
node_get -->|"formats results"| node_result
node_result -->|"writes output"| node_stdout
node_user -->|"requests upgrade"| node_upgrade
node_upgrade -->|"fetches release"| node_release_service

click node_entry "https://github.com/gmeghnag/koff/blob/main/main.go"
click node_commands "https://github.com/gmeghnag/koff/blob/main/cmd/koff.go"
click node_context "https://github.com/gmeghnag/koff/blob/main/cmd/use.go"
click node_config "https://github.com/gmeghnag/koff/blob/main/cmd/use.go"
click node_get "https://github.com/gmeghnag/koff/blob/main/cmd/get/get.go"
click node_resource_helpers "https://github.com/gmeghnag/koff/blob/main/cmd/get/helpers.go"
click node_deserializer "https://github.com/gmeghnag/koff/blob/main/pkg/deserializer/deserializer.go"
click node_etcd "https://github.com/gmeghnag/koff/blob/main/cmd/etcd/encoding.go"
click node_resource_types "https://github.com/gmeghnag/koff/blob/main/types/know-types.go"
click node_shared_helpers "https://github.com/gmeghnag/koff/blob/main/pkg/helpers/helpers.go"
click node_tablegen "https://github.com/gmeghnag/koff/blob/main/pkg/tablegenerator/tablegenerator.go"
click node_result "https://github.com/gmeghnag/koff/blob/main/cmd/koff.go"
click node_upgrade "https://github.com/gmeghnag/koff/blob/main/cmd/upgrade/upgrade.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_entry,node_commands,node_context,node_config,node_user toneBlue
class node_get,node_resource_helpers,node_deserializer,node_etcd,node_resource_types,node_shared_helpers toneAmber
class node_tablegen,node_result,node_stdout toneMint
class node_upgrade,node_release_service toneRose
```

## Components

### CLI and Context

- [Program Entry](https://github.com/gmeghnag/koff/blob/main/main.go): `main.go`
- [Root Commands](https://github.com/gmeghnag/koff/blob/main/cmd/koff.go): `cmd/koff.go`
- [Input Context](https://github.com/gmeghnag/koff/blob/main/cmd/use.go): `cmd/use.go`
- [Saved Context](https://github.com/gmeghnag/koff/blob/main/cmd/use.go): `cmd/use.go`

### Resource Processing

- [Resource Get](https://github.com/gmeghnag/koff/blob/main/cmd/get/get.go): `cmd/get/get.go`
- [Resource Helpers](https://github.com/gmeghnag/koff/blob/main/cmd/get/helpers.go): `cmd/get/helpers.go`
- [Manifest Decoder](https://github.com/gmeghnag/koff/blob/main/pkg/deserializer/deserializer.go): `pkg/deserializer/deserializer.go`
- [Etcd Snapshot Reader](https://github.com/gmeghnag/koff/blob/main/cmd/etcd/encoding.go): `cmd/etcd/encoding.go`
- [Resource Types](https://github.com/gmeghnag/koff/blob/main/types/know-types.go): `types/know-types.go`
- [Data Helpers](https://github.com/gmeghnag/koff/blob/main/pkg/helpers/helpers.go): `pkg/helpers/helpers.go`

### Output Rendering

- [Table Generator](https://github.com/gmeghnag/koff/blob/main/pkg/tablegenerator/tablegenerator.go): `pkg/tablegenerator/tablegenerator.go`
- [Rendered Results](https://github.com/gmeghnag/koff/blob/main/cmd/koff.go): `cmd/koff.go`
- **Terminal Output**

### Tool Maintenance

- [Upgrade Command](https://github.com/gmeghnag/koff/blob/main/cmd/upgrade/upgrade.go): `cmd/upgrade/upgrade.go`
- **Release Service**

### Other components

- **CLI User**

## Connections

- CLI User → Program Entry: runs (evidence: `main.go`)
- Program Entry → Root Commands: executes (evidence: `main.go`)
- Root Commands → Resource Get: registers (evidence: `cmd/koff.go`)
- Root Commands → Input Context: registers (evidence: `cmd/koff.go`)
- Root Commands → Upgrade Command: registers (evidence: `cmd/koff.go`)
- CLI User → Input Context: selects input (evidence: `README.md`)
- Input Context → Saved Context: writes context (evidence: `cmd/use.go`)
- Saved Context → Resource Get: provides input
- Resource Get → Resource Helpers: resolves resources (evidence: `cmd/get/get.go`)
- Resource Get → Manifest Decoder: decodes input (evidence: `cmd/get/get.go`)
- Resource Get → Resource Types: uses resource types (evidence: `cmd/get/get.go`)
- Resource Get → Data Helpers: uses helpers (evidence: `cmd/get/get.go`)
- Resource Get → Table Generator: builds tables (evidence: `cmd/get/get.go`)
- Resource Get → Etcd Snapshot Reader: reads snapshot
- Resource Get → Rendered Results: formats results (evidence: `cmd/koff.go`)
- Rendered Results → Terminal Output: writes output (evidence: `cmd/koff.go`)
- CLI User → Upgrade Command: requests upgrade (evidence: `README.md`)
- Upgrade Command → Release Service: fetches release (evidence: `cmd/upgrade/upgrade.go`)
