How badtuxx/girus-cli works
GIRUS is a local CLI for creating and managing isolated interactive learning labs on Kubernetes. The main workflow provisions the GIRUS cluster, installs lab templates or repository labs, and lets the user inspect and manage the running environment. Repository management, multilingual manifests, and CLI updates are additional capabilities. The backend and frontend are described in the README but their implementation is not present in this repository; links to them reflect documented or excerpted CLI interactions.
Main entry points: root.go Command router · create.go Create cluster · lab.go Lab commands · repo.go Repository manager
Components 24
CLI entry
- Program entry
main.go - Command router
cmd/root.go
Cluster lifecycle
- Create cluster
cmd/create.go - Delete cluster
cmd/delete.go - Start services
cmd/start.go - Stop services
cmd/stop.go - Cluster status
cmd/status.go - CLI update
cmd/update.go
Labs and repositories
- Lab commands
cmd/lab.go - Lab creation
cmd/create.go - Lab manager
internal/lab/lab.go - Repository manager
internal/repo/repo.go - Repository index
internal/repo/index.go - Repository lab access
internal/repo/lab.go - Lab manifests
internal/templates/manifests - Manifest selector
internal/templates/templates.go
Kubernetes operations
- Kubernetes client
internal/k8s/k8s.go - Kind / Kubernetes
- GIRUS backend
- GIRUS frontend
Configuration
- Language and config
internal/common/config.go - Progress helpers
internal/helpers/helpers.go - Release service
Other components
- CLI user
Connections 38
- CLI user → Program entry: runs CLI
README.md - Program entry → Language and config: loads language
main.go - Program entry → Command router: executes
main.go - Command router → Create cluster: routes command
- Command router → Delete cluster: routes command
- Command router → Start services: routes command
- Command router → Stop services: routes command
- Command router → Cluster status: routes command
- Command router → CLI update: routes command
- Command router → Lab commands: routes command
- Create cluster → Kind / Kubernetes: provisions cluster
README.md - Create cluster → Manifest selector: reads manifests
cmd/create.go - Manifest selector → Lab manifests: selects language
internal/templates/templates.go - Create cluster → Progress helpers: shows progress
cmd/create.go - Create cluster → Lab manager: creates lab
cmd/create.go - Create cluster → Repository manager: loads repo lab
cmd/create.go - Create cluster → Kubernetes client: uses Kubernetes
cmd/create.go - Delete cluster → Kind / Kubernetes: deletes cluster
cmd/delete.go - Delete cluster → Progress helpers: shows progress
cmd/delete.go - Start services → Kubernetes client: starts services
cmd/start.go - Stop services → Kubernetes client: stops deployments
cmd/stop.go - Kubernetes client → Kind / Kubernetes: manages resources
- Cluster status → Kind / Kubernetes: queries status
cmd/status.go - Cluster status → GIRUS backend: checks component
cmd/status.go - Cluster status → GIRUS frontend: checks component
cmd/status.go - CLI update → Release service: checks release
cmd/update.go - CLI update → Delete cluster: may recreate cluster
cmd/update.go - CLI update → Create cluster: may recreate cluster
cmd/update.go - Lab commands → Repository manager: lists and installs
cmd/lab.go - Lab commands → Repository lab access: downloads lab
- Repository manager → Repository index: reads index
- Repository manager → Repository lab access: retrieves lab
- Repository manager → Release service: fetches repository
internal/repo/repo.go - Lab creation → Lab manager: delegates file lab
cmd/create.go - Lab manager → Kind / Kubernetes: applies lab
internal/lab/lab.go - Lab manager → GIRUS backend: restarts backend
internal/lab/lab.go - Lab commands → GIRUS backend: restarts backend
cmd/lab.go - Lab commands → Kind / Kubernetes: queries lab API
cmd/lab.go