# sima-neat/sima-cli architecture

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

- Interactive diagram: https://gitdiagram.com/sima-neat/sima-cli
- Repository: https://github.com/sima-neat/sima-cli

## Overview

sima-cli is a command-line tool for SiMa developer workflows. A user invokes a command through the CLI, which exposes authentication, SDK setup, package installation, artifact and zoo access, and DevKit discovery and update operations. The implementation separates command entry points from domain workflows and shared configuration/API utilities. The README documents capabilities whose implementation excerpts were not supplied; those branches are represented without inferring internal call sequences. Edges are limited to documented workflows and relationships visible in the source index or excerpts.

Main entry points: [`sima_cli/cli.py`](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/cli.py) (Command interface), [`sima_cli/update/updater.py`](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/updater.py) (Update orchestration), [`sima_cli/install/metadata_installer.py`](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/install/metadata_installer.py) (Metadata installer), [`sima_cli/update/netboot.py`](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/netboot.py) (Netboot workflow)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and auth"]
  node_cli["Command interface<br/>[cli.py]"]
  node_login["Portal login<br/>[login.py]"]
end

subgraph group_artifacts["Packages and content"]
  node_installer["Metadata installer"]
  node_registry[("Package registry<br/>[registry.py]")]
  node_downloader["Artifact downloader<br/>[downloader.py]"]
  node_model_zoo["Model Zoo<br/>[model.py]"]
  node_app_zoo["App Zoo<br/>[app.py]"]
  node_vulcan["Neat artifacts<br/>[artifacts.py]"]
end

subgraph group_devices["Devices and updates"]
  node_discovery["Device discovery<br/>[discover.py]"]
  node_device_ops["Device and MPK ops<br/>[commands.py]"]
  node_network["Network config<br/>[network.py]"]
  node_updater["Update orchestration<br/>[updater.py]"]
  node_netboot["Netboot workflow<br/>[netboot.py]"]
  node_remote["Remote device access<br/>[remote.py]"]
  node_serial["Serial console<br/>[serial.py]"]
  node_storage["DevKit storage<br/>[nvme.py]"]
end

subgraph group_development["Developer tools"]
  node_sdk["SDK environments<br/>[commands.py]"]
  node_playbooks["Playbooks<br/>[manager.py]"]
end

subgraph group_shared["Shared services"]
  node_credentials[("Credential config<br/>[config.py]")]
  node_resource_config["Resource config<br/>[config_loader.py]"]
  node_device_api["Device APIs<br/>[device_api.py]"]
  node_mpk_api["MPK APIs<br/>[mpk_api.py]"]
  node_artifactory["Artifact service"]
end

node_user(("Developer"))

node_user -->|"runs commands"| node_cli
node_cli -->|"dispatches login"| node_login
node_login -->|"stores credentials"| node_credentials
node_cli -->|"dispatches install"| node_installer
node_installer -->|"downloads resources"| node_downloader
node_cli -->|"manages packages"| node_registry
node_cli -->|"dispatches modelzoo"| node_model_zoo
node_cli -->|"dispatches appzoo"| node_app_zoo
node_app_zoo -->|"downloads content"| node_downloader
node_cli -->|"dispatches neat"| node_vulcan
node_cli -->|"dispatches sdk"| node_sdk
node_cli -->|"dispatches playbooks"| node_playbooks
node_cli -->|"dispatches device"| node_discovery
node_cli -->|"dispatches network"| node_network
node_cli -->|"dispatches update"| node_updater
node_updater -->|"uses remote access"| node_remote
node_updater -->|"uses netboot artifacts"| node_netboot
node_netboot -->|"uses update helpers"| node_updater
node_netboot -->|"uses remote access"| node_remote
node_cli -->|"dispatches serial"| node_serial
node_cli -->|"dispatches nvme"| node_storage
node_device_ops -->|"uses device API"| node_device_api
node_device_ops -->|"uses MPK API"| node_mpk_api
node_installer -.->|"fetches metadata"| node_artifactory
node_updater -->|"loads resources"| node_resource_config
node_cli -->|"probes devices"| node_discovery

click node_cli "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/cli.py"
click node_login "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/auth/login.py"
click node_credentials "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/config.py"
click node_resource_config "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/config_loader.py"
click node_installer "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/install/metadata_installer.py"
click node_registry "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/install/registry.py"
click node_downloader "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/download/downloader.py"
click node_model_zoo "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/model_zoo/model.py"
click node_app_zoo "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/app_zoo/app.py"
click node_vulcan "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/vulcan/artifacts.py"
click node_sdk "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/sdk/commands.py"
click node_playbooks "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/playbooks/manager.py"
click node_discovery "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/discover/discover.py"
click node_device_ops "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/deploy_only/device/commands.py"
click node_device_api "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/device_api.py"
click node_mpk_api "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/mpk_api.py"
click node_network "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/network/network.py"
click node_updater "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/updater.py"
click node_netboot "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/netboot.py"
click node_remote "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/remote.py"
click node_serial "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/serial/serial.py"
click node_storage "https://github.com/sima-neat/sima-cli/blob/main/sima_cli/storage/nvme.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_login toneBlue
class node_installer,node_registry,node_downloader,node_model_zoo,node_app_zoo,node_vulcan toneAmber
class node_discovery,node_device_ops,node_network,node_updater,node_netboot,node_remote,node_serial,node_storage toneMint
class node_sdk,node_playbooks toneRose
class node_credentials,node_resource_config,node_device_api,node_mpk_api,node_artifactory,node_user toneIndigo
```

## Components

### CLI and auth

- [Command interface](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/cli.py): `sima_cli/cli.py`
- [Portal login](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/auth/login.py): `sima_cli/auth/login.py`

### Packages and content

- [Metadata installer](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/install/metadata_installer.py): `sima_cli/install/metadata_installer.py`
- [Package registry](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/install/registry.py): `sima_cli/install/registry.py`
- [Artifact downloader](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/download/downloader.py): `sima_cli/download/downloader.py`
- [Model Zoo](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/model_zoo/model.py): `sima_cli/model_zoo/model.py`
- [App Zoo](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/app_zoo/app.py): `sima_cli/app_zoo/app.py`
- [Neat artifacts](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/vulcan/artifacts.py): `sima_cli/vulcan/artifacts.py`

### Devices and updates

- [Device discovery](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/discover/discover.py): `sima_cli/discover/discover.py`
- [Device and MPK ops](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/deploy_only/device/commands.py): `sima_cli/deploy_only/device/commands.py`
- [Network config](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/network/network.py): `sima_cli/network/network.py`
- [Update orchestration](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/updater.py): `sima_cli/update/updater.py`
- [Netboot workflow](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/netboot.py): `sima_cli/update/netboot.py`
- [Remote device access](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/update/remote.py): `sima_cli/update/remote.py`
- [Serial console](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/serial/serial.py): `sima_cli/serial/serial.py`
- [DevKit storage](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/storage/nvme.py): `sima_cli/storage/nvme.py`

### Developer tools

- [SDK environments](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/sdk/commands.py): `sima_cli/sdk/commands.py`
- [Playbooks](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/playbooks/manager.py): `sima_cli/playbooks/manager.py`

### Shared services

- [Credential config](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/config.py): `sima_cli/utils/config.py`
- [Resource config](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/config_loader.py): `sima_cli/utils/config_loader.py`
- [Device APIs](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/device_api.py): `sima_cli/utils/device_api.py`
- [MPK APIs](https://github.com/sima-neat/sima-cli/blob/main/sima_cli/utils/mpk_api.py): `sima_cli/utils/mpk_api.py`
- **Artifact service**

### Other components

- **Developer**

## Connections

- Developer → Command interface: runs commands (evidence: `README.md`)
- Command interface → Portal login: dispatches login (evidence: `sima_cli/cli.py`)
- Portal login → Credential config: stores credentials (evidence: `sima_cli/auth/login.py`)
- Command interface → Metadata installer: dispatches install (evidence: `sima_cli/cli.py`)
- Metadata installer → Artifact downloader: downloads resources (evidence: `sima_cli/install/metadata_installer.py`)
- Command interface → Package registry: manages packages (evidence: `README.md`)
- Command interface → Model Zoo: dispatches modelzoo (evidence: `sima_cli/cli.py`)
- Command interface → App Zoo: dispatches appzoo (evidence: `sima_cli/cli.py`)
- App Zoo → Artifact downloader: downloads content (evidence: `sima_cli/app_zoo/app.py`)
- Command interface → Neat artifacts: dispatches neat (evidence: `README.md`)
- Command interface → SDK environments: dispatches sdk (evidence: `README.md`)
- Command interface → Playbooks: dispatches playbooks (evidence: `README.md`)
- Command interface → Device discovery: dispatches device (evidence: `README.md`)
- Command interface → Network config: dispatches network (evidence: `README.md`)
- Command interface → Update orchestration: dispatches update (evidence: `sima_cli/cli.py`)
- Update orchestration → Remote device access: uses remote access (evidence: `sima_cli/update/updater.py`)
- Update orchestration → Netboot workflow: uses netboot artifacts (evidence: `sima_cli/update/updater.py`)
- Netboot workflow → Update orchestration: uses update helpers (evidence: `sima_cli/update/netboot.py`)
- Netboot workflow → Remote device access: uses remote access (evidence: `sima_cli/update/netboot.py`)
- Command interface → Serial console: dispatches serial (evidence: `README.md`)
- Command interface → DevKit storage: dispatches nvme (evidence: `README.md`)
- Device and MPK ops → Device APIs: uses device API (evidence: `sima_cli/deploy_only/device/commands.py`)
- Device and MPK ops → MPK APIs: uses MPK API
- Metadata installer → Artifact service: fetches metadata
- Update orchestration → Resource config: loads resources (evidence: `sima_cli/update/updater.py`)
- Command interface → Device discovery: probes devices (evidence: `sima_cli/cli.py`)
