Documentation
¶
Overview ¶
Package cli provides reusable helpers for command wiring and execution.
This package is organized into subpackages for different functionality:
- cmd: Cobra command implementations for cluster, cipher, and workload commands
- helpers: Common CLI utilities (Docker client lifecycle, editor resolution, flag handling, kubeconfig path resolution)
- lifecycle: Cluster lifecycle command helpers (start, stop, delete, etc.)
- setup: Cluster create command helpers and installer factories
- ui: User interface components (asciiart, errorhandler)
Related packages (located in pkg/utils):
- utils/notify: Message formatting with symbols, colors, and timing
- utils/runner: Command runner utilities for executing commands with output capture
- utils/timer: Execution time tracking for operations
The utilities in this package follow dependency injection patterns and integrate with the KSail runtime container for testability and flexibility.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides the command-line interface for KSail.
|
Package cmd provides the command-line interface for KSail. |
|
cipher
Package cipher provides the cipher command for integrating with SOPS.
|
Package cipher provides the cipher command for integrating with SOPS. |
|
cluster
Package cluster groups all KSail cluster lifecycle Cobra commands under a single namespace.
|
Package cluster groups all KSail cluster lifecycle Cobra commands under a single namespace. |
|
workload
Package workload provides the workload command namespace.
|
Package workload provides the workload command namespace. |
|
workload/gen
Package gen provides the gen command namespace for generating Kubernetes resources.
|
Package gen provides the gen command namespace for generating Kubernetes resources. |
|
Package helpers provides common CLI utilities for command handling.
|
Package helpers provides common CLI utilities for command handling. |
|
Package lifecycle provides cluster lifecycle command helpers.
|
Package lifecycle provides cluster lifecycle command helpers. |
|
Package setup provides helpers for cluster creation and setup workflows.
|
Package setup provides helpers for cluster creation and setup workflows. |
|
localregistry
Package localregistry provides local registry lifecycle operations for cluster commands.
|
Package localregistry provides local registry lifecycle operations for cluster commands. |
|
mirrorregistry
Package mirrorregistry provides mirror registry setup and connection stages for cluster creation.
|
Package mirrorregistry provides mirror registry setup and connection stages for cluster creation. |
|
Package ui provides user interface components for KSail CLI.
|
Package ui provides user interface components for KSail CLI. |
|
asciiart
Package asciiart provides ASCII art printing functionality for KSail.
|
Package asciiart provides ASCII art printing functionality for KSail. |
|
errorhandler
Package errorhandler centralizes Cobra command execution with KSail's error formatting rules.
|
Package errorhandler centralizes Cobra command execution with KSail's error formatting rules. |
Click to show internal directories.
Click to hide internal directories.