Documentation
¶
Overview ¶
Package cli provides reusable helpers for command wiring and execution.
This package is organized into subpackages for different functionality:
- cli/docker: Docker client lifecycle management with automatic cleanup
- cli/editor: Editor configuration resolution with proper precedence
- cli/flags: Flag handling utilities including timing detection
- cli/kubeconfig: Kubeconfig path resolution with home directory expansion
- cli/lifecycle: Cluster lifecycle command helpers (start, stop, delete, etc.)
- cli/create: Cluster create command helpers and installer factories
- cli/parallel: Parallel task execution with controlled concurrency
- cli/runner: Command runner utilities for executing commands with output capture
- cli/ui: User interface components (asciiart, errorhandler, notify, timer)
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 create provides helpers for cluster creation workflows.
|
Package create provides helpers for cluster creation workflows. |
|
registrystage
Package registrystage provides registry setup and connection stages for cluster creation.
|
Package registrystage provides registry setup and connection stages for cluster creation. |
|
Package docker provides Docker client lifecycle management for CLI commands.
|
Package docker provides Docker client lifecycle management for CLI commands. |
|
Package editor provides editor configuration resolution for CLI commands.
|
Package editor provides editor configuration resolution for CLI commands. |
|
Package flags provides flag handling utilities for CLI commands.
|
Package flags provides flag handling utilities for CLI commands. |
|
Package kubeconfig provides kubeconfig path resolution utilities.
|
Package kubeconfig provides kubeconfig path resolution utilities. |
|
Package lifecycle provides cluster lifecycle command helpers.
|
Package lifecycle provides cluster lifecycle command helpers. |
|
Package parallel provides utilities for executing independent operations concurrently with controlled parallelism using errgroup and semaphore.
|
Package parallel provides utilities for executing independent operations concurrently with controlled parallelism using errgroup and semaphore. |
|
Package runner provides helpers for executing Cobra commands while capturing output.
|
Package runner provides helpers for executing Cobra commands while capturing output. |
|
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. |
|
error-handler
Package errorhandler centralizes Cobra command execution with KSail's error formatting rules.
|
Package errorhandler centralizes Cobra command execution with KSail's error formatting rules. |
|
notify
Package notify provides utilities for sending notifications to the user.
|
Package notify provides utilities for sending notifications to the user. |
|
timer
Package timer provides timing functionality for tracking command execution duration.
|
Package timer provides timing functionality for tracking command execution duration. |
Click to show internal directories.
Click to hide internal directories.