# maxsander123/netcup-cli architecture

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

- Interactive diagram: https://gitdiagram.com/maxsander123/netcup-cli
- Repository: https://github.com/maxsander123/netcup-cli

## Overview

netcup-cli is a command-line client for Netcup’s Server Control Panel (SCP) and Customer Control Panel (CCP) DNS APIs. Users invoke commands to authenticate, inspect or manage servers, and work with CCP DNS; command handlers send requests to the relevant API and format results, with asynchronous SCP tasks optionally polled for completion. The map separates SCP operations, CCP DNS modes, and shared runtime services. Relationships are limited to those shown in excerpts, the source index, or README; unsampled command behavior is represented at subsystem level.

Main entry points: [`src/netcup_cli/cli.py`](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/cli.py) (Command router), [`src/netcup_cli/client.py`](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/client.py) (SCP API client), [`src/netcup_cli/commands/dns.py`](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/dns.py) (DNS command routing), [`src/netcup_cli/commands/tasks.py`](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/tasks.py) (Async tasks)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and presentation"]
  node_cli["Command router<br/>[cli.py]"]
  node_presentation["Output and task wait<br/>[output.py]"]
end

subgraph group_scp["SCP operations"]
  node_server_ops["Server and snapshots<br/>[servers.py]"]
  node_image_ops["OS images and install<br/>[images.py]"]
  node_network_ops["Networking and rDNS<br/>[networking.py]"]
  node_user_ops["Users and resources<br/>[users.py]"]
  node_task_ops["Async tasks<br/>[tasks.py]"]
  node_other_ops["Disks and metrics"]
end

subgraph group_dns["CCP DNS"]
  node_ccp_auth[("CCP credentials<br/>[ccp_config.py]")]
  node_dns_ops["DNS command routing<br/>[dns.py]"]
  node_legacy_dns["Legacy DNS<br/>[legacy_dns.py]"]
  node_rest_dns["CloudDNS REST<br/>[netcup_dns_api.py]"]
  node_ddns["Dynamic DNS<br/>[ddns.py]"]
end

subgraph group_runtime["Shared runtime"]
  node_scp_auth["SCP authentication<br/>[auth.py]"]
  node_scp_config[("SCP credentials<br/>[config.py]")]
  node_scp_client["SCP API client<br/>[client.py]"]
end

node_user(("CLI user"))
node_scp_service{{"SCP REST API"}}
node_ccp_service{{"CCP DNS APIs"}}

node_user -->|"invokes"| node_cli
node_cli -->|"formats results"| node_presentation
node_cli -->|"routes commands"| node_server_ops
node_cli -->|"routes commands"| node_image_ops
node_cli -->|"routes commands"| node_network_ops
node_cli -->|"routes commands"| node_user_ops
node_cli -->|"routes commands"| node_task_ops
node_cli -->|"routes commands"| node_other_ops
node_cli -->|"routes commands"| node_dns_ops
node_server_ops -->|"builds client"| node_scp_client
node_image_ops -->|"builds client"| node_scp_client
node_network_ops -->|"builds client"| node_scp_client
node_user_ops -->|"builds client"| node_scp_client
node_task_ops -->|"builds client"| node_scp_client
node_other_ops -->|"uses client"| node_scp_client
node_scp_client -->|"refreshes token"| node_scp_auth
node_scp_client -->|"loads credentials"| node_scp_config
node_scp_auth -->|"uses settings"| node_scp_config
node_scp_client -->|"sends requests"| node_scp_service
node_scp_auth -->|"authenticates"| node_scp_service
node_task_ops -->|"prints results"| node_presentation
node_presentation -->|"polls tasks"| node_scp_client
node_dns_ops -->|"loads credentials"| node_ccp_auth
node_dns_ops -->|"calls legacy API"| node_legacy_dns
node_dns_ops -->|"calls REST API"| node_rest_dns
node_dns_ops -->|"uses DDNS"| node_ddns
node_legacy_dns -->|"uses credentials"| node_ccp_auth
node_legacy_dns -.->|"sends requests"| node_ccp_service
node_rest_dns -.->|"sends requests"| node_ccp_service
node_ddns -.->|"updates records"| node_ccp_service

click node_cli "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/cli.py"
click node_presentation "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/output.py"
click node_scp_auth "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/auth.py"
click node_scp_config "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/config.py"
click node_scp_client "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/client.py"
click node_server_ops "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/servers.py"
click node_image_ops "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/images.py"
click node_network_ops "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/networking.py"
click node_user_ops "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/users.py"
click node_task_ops "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/tasks.py"
click node_other_ops "https://github.com/maxsander123/netcup-cli/tree/main/src/netcup_cli/commands"
click node_ccp_auth "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/ccp_config.py"
click node_dns_ops "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/dns.py"
click node_legacy_dns "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/legacy_dns.py"
click node_rest_dns "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/netcup_dns_api.py"
click node_ddns "https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/ddns.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_presentation,node_user toneBlue
class node_server_ops,node_image_ops,node_network_ops,node_user_ops,node_task_ops,node_other_ops toneAmber
class node_ccp_auth,node_dns_ops,node_legacy_dns,node_rest_dns,node_ddns,node_scp_service,node_ccp_service toneMint
class node_scp_auth,node_scp_config,node_scp_client toneRose
```

## Components

### CLI and presentation

- [Command router](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/cli.py): `src/netcup_cli/cli.py`
- [Output and task wait](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/output.py): `src/netcup_cli/output.py`

### SCP operations

- [Server and snapshots](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/servers.py): `src/netcup_cli/commands/servers.py`
- [OS images and install](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/images.py): `src/netcup_cli/commands/images.py`
- [Networking and rDNS](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/networking.py): `src/netcup_cli/commands/networking.py`
- [Users and resources](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/users.py): `src/netcup_cli/commands/users.py`
- [Async tasks](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/tasks.py): `src/netcup_cli/commands/tasks.py`
- [Disks and metrics](https://github.com/maxsander123/netcup-cli/tree/main/src/netcup_cli/commands): `src/netcup_cli/commands`

### CCP DNS

- [CCP credentials](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/ccp_config.py): `src/netcup_cli/ccp_config.py`
- [DNS command routing](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/commands/dns.py): `src/netcup_cli/commands/dns.py`
- [Legacy DNS](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/legacy_dns.py): `src/netcup_cli/legacy_dns.py`
- [CloudDNS REST](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/netcup_dns_api.py): `src/netcup_cli/netcup_dns_api.py`
- [Dynamic DNS](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/ddns.py): `src/netcup_cli/ddns.py`

### Shared runtime

- [SCP authentication](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/auth.py): `src/netcup_cli/auth.py`
- [SCP credentials](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/config.py): `src/netcup_cli/config.py`
- [SCP API client](https://github.com/maxsander123/netcup-cli/blob/main/src/netcup_cli/client.py): `src/netcup_cli/client.py`

### Other components

- **CLI user**
- **SCP REST API**
- **CCP DNS APIs**

## Connections

- CLI user → Command router: invokes (evidence: `README.md`)
- Command router → Output and task wait: formats results (evidence: `src/netcup_cli/cli.py`)
- Command router → Server and snapshots: routes commands (evidence: `src/netcup_cli/cli.py`)
- Command router → OS images and install: routes commands (evidence: `src/netcup_cli/cli.py`)
- Command router → Networking and rDNS: routes commands (evidence: `src/netcup_cli/cli.py`)
- Command router → Users and resources: routes commands (evidence: `src/netcup_cli/cli.py`)
- Command router → Async tasks: routes commands (evidence: `src/netcup_cli/cli.py`)
- Command router → Disks and metrics: routes commands (evidence: `src/netcup_cli/cli.py`)
- Command router → DNS command routing: routes commands (evidence: `src/netcup_cli/cli.py`)
- Server and snapshots → SCP API client: builds client (evidence: `src/netcup_cli/commands/servers.py`)
- OS images and install → SCP API client: builds client (evidence: `src/netcup_cli/commands/images.py`)
- Networking and rDNS → SCP API client: builds client (evidence: `src/netcup_cli/commands/networking.py`)
- Users and resources → SCP API client: builds client (evidence: `src/netcup_cli/commands/users.py`)
- Async tasks → SCP API client: builds client (evidence: `src/netcup_cli/commands/tasks.py`)
- Disks and metrics → SCP API client: uses client (evidence: `src/netcup_cli/commands/tasks.py`)
- SCP API client → SCP authentication: refreshes token (evidence: `src/netcup_cli/client.py`)
- SCP API client → SCP credentials: loads credentials (evidence: `src/netcup_cli/client.py`)
- SCP authentication → SCP credentials: uses settings (evidence: `src/netcup_cli/auth.py`)
- SCP API client → SCP REST API: sends requests (evidence: `src/netcup_cli/client.py`)
- SCP authentication → SCP REST API: authenticates (evidence: `src/netcup_cli/auth.py`)
- Async tasks → Output and task wait: prints results (evidence: `src/netcup_cli/commands/tasks.py`)
- Output and task wait → SCP API client: polls tasks (evidence: `src/netcup_cli/output.py`)
- DNS command routing → CCP credentials: loads credentials (evidence: `src/netcup_cli/commands/dns.py`)
- DNS command routing → Legacy DNS: calls legacy API (evidence: `src/netcup_cli/commands/dns.py`)
- DNS command routing → CloudDNS REST: calls REST API (evidence: `src/netcup_cli/commands/dns.py`)
- DNS command routing → Dynamic DNS: uses DDNS (evidence: `src/netcup_cli/commands/dns.py`)
- Legacy DNS → CCP credentials: uses credentials (evidence: `src/netcup_cli/legacy_dns.py`)
- Legacy DNS → CCP DNS APIs: sends requests
- CloudDNS REST → CCP DNS APIs: sends requests
- Dynamic DNS → CCP DNS APIs: updates records
