KSail CLI Options
Important
This document is auto-generated by src/KSail.Docs/CLIOptionsGenerator.cs and is always up-to-date with the latest version of the KSail CLI.
KSail supports CLI options for configuring the behavior of KSail. These options can be used to override the default settings, or to alter the behavior of KSail in specific ways.
ksail
Description:
KSail is an SDK for Kubernetes. Ship k8s with ease!
Usage:
ksail [command] [options]
Options:
--version Show version information
--helpz Show help and usage information
Commands:
init Initialize a new project
up Create a cluster
update Update a cluster
start Start a cluster
stop Stop a cluster
down Destroy a cluster
status Show the status of a cluster
list List active clusters
validate Validate project files
connect Connect to a cluster with K9s
gen Generate a resource
secrets Manage secrets
run Run a command
ksail init
Description:
Initialize a new project
Usage:
ksail init [options]
Options:
-o, --output <output> Output directory for the project files. [default: ./] [default: ./]
-n, --name <name> The name of the cluster. [default: ksail-default]
-c, --config <config> The path to the ksail configuration file. [default: ksail.yaml]
-dc, --distribution-config <distribution-config> Path to the distribution configuration file. [default: kind.yaml]
-kp, --kustomization-path <kustomization-path> The path to the root kustomization directory. [default: k8s]
-ce, --container-engine <Docker|Podman> The container engine in which to provision the cluster. [default: Docker]
-d, --distribution <K3d|Kind> The distribution to use for the cluster. [default: Kind]
-dt, --deployment-tool <Flux|Kubectl> The Deployment tool to use for applying a kustomization. [default: Kubectl]
--cni <Cilium|Default|None> The CNI to use. [default: Default]
--csi <Default|LocalPathProvisioner|None> The CSI to use. [default: Default]
-ic, --ingress-controller <Default|None|Traefik> The Ingress Controller to use. [default: Default]
-gc, --gateway-controller <Default|None> The Gateway Controller to use. [default: Default]
-ms, --metrics-server Whether to install Metrics Server. [default: True]
-mr, --mirror-registries Enable mirror registries for the project. [default: True]
-sm, --secret-manager <None|SOPS> Whether to use a secret manager. [default: None]
-e, --editor <Nano|Vim> Editor to use. [default: Nano]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail up
Description:
Create a cluster
Usage:
ksail up [options]
Options:
-c, --context <context> The kubernetes context to use. [default: kind-ksail-default]
-k, --kubeconfig <kubeconfig> Path to kubeconfig file. [default: ~/.kube/config]
-t, --timeout <timeout> The time to wait for each kustomization to become ready. [default: 5m]
-n, --name <name> The name of the cluster. [default: ksail-default]
-dc, --distribution-config <distribution-config> Path to the distribution configuration file. [default: kind.yaml]
-kp, --kustomization-path <kustomization-path> The path to the root kustomization directory. [default: k8s]
-ce, --container-engine <Docker|Podman> The container engine in which to provision the cluster. [default: Docker]
-d, --distribution <K3d|Kind> The distribution to use for the cluster. [default: Kind]
-dt, --deployment-tool <Flux|Kubectl> The Deployment tool to use for applying a kustomization. [default: Kubectl]
--cni <Cilium|Default|None> The CNI to use. [default: Default]
--csi <Default|LocalPathProvisioner|None> The CSI to use. [default: Default]
-ic, --ingress-controller <Default|None|Traefik> The Ingress Controller to use. [default: Default]
-gc, --gateway-controller <Default|None> The Gateway Controller to use. [default: Default]
-ms, --metrics-server Whether to install Metrics Server. [default: True]
-mr, --mirror-registries Enable mirror registries for the project. [default: True]
-sm, --secret-manager <None|SOPS> Whether to use a secret manager. [default: None]
-fsu, --flux-source-url <flux-source-url> Flux source URL for reconciling GitOps resources. [default: oci://ksail-registry:5000/ksail-registry]
-v, --validate Validate project files before creating a new cluster. [default: True]
-r, --reconcile Reconcile manifests. [default: True]
--helpz Show help and usage information
ksail update
Description:
Update a cluster
Usage:
ksail update [options]
Options:
-c, --context <context> The kubernetes context to use. [default: kind-ksail-default]
-k, --kubeconfig <kubeconfig> Path to kubeconfig file. [default: ~/.kube/config]
-kp, --kustomization-path <kustomization-path> The path to the root kustomization directory. [default: k8s]
-dt, --deployment-tool <Flux|Kubectl> The Deployment tool to use for applying a kustomization. [default: Kubectl]
-p, --publish Publish manifests. [default: True]
-v, --validate Validate project files before applying changes to an existing cluster. [default: True]
-r, --reconcile Reconcile manifests. [default: True]
--helpz Show help and usage information
ksail start
Description:
Start a cluster
Usage:
ksail start [options]
Options:
-c, --context <context> The kubernetes context to use. [default: kind-ksail-default]
-n, --name <name> The name of the cluster. [default: ksail-default]
-ce, --container-engine <Docker|Podman> The container engine in which to provision the cluster. [default: Docker]
-d, --distribution <K3d|Kind> The distribution to use for the cluster. [default: Kind]
--helpz Show help and usage information
ksail stop
Description:
Stop a cluster
Usage:
ksail stop [options]
Options:
-n, --name <name> The name of the cluster. [default: ksail-default]
-ce, --container-engine <Docker|Podman> The container engine in which to provision the cluster. [default: Docker]
-d, --distribution <K3d|Kind> The distribution to use for the cluster. [default: Kind]
--helpz Show help and usage information
ksail down
Description:
Destroy a cluster
Usage:
ksail down [options]
Options:
-fsu, --flux-source-url <flux-source-url> Flux source URL for reconciling GitOps resources. [default: oci://ksail-registry:5000/ksail-registry]
-n, --name <name> The name of the cluster. [default: ksail-default]
-d, --distribution <K3d|Kind> The distribution to use for the cluster. [default: Kind]
-ce, --container-engine <Docker|Podman> The container engine in which to provision the cluster. [default: Docker]
-mr, --mirror-registries Enable mirror registries for the project. [default: True]
--helpz Show help and usage information
ksail status
Description:
Show the status of a cluster
Usage:
ksail status [options]
Options:
-k, --kubeconfig <kubeconfig> Path to kubeconfig file. [default: ~/.kube/config]
-c, --context <context> The kubernetes context to use. [default: kind-ksail-default]
--verbose Verbose output for validation or status checks. [default: False]
--helpz Show help and usage information
ksail list
Description:
List active clusters
Usage:
ksail list [options]
Options:
-ce, --container-engine <Docker|Podman> The container engine in which to provision the cluster. [default: Docker]
-d, --distribution <K3d|Kind> The distribution to use for the cluster. [default: Kind]
-a, --all List clusters from all distributions. [default: False]
--helpz Show help and usage information
ksail validate
Description:
Validate project files
Usage:
ksail validate [options]
Options:
-p, --path <path> Path to the project files. [default: ./] [default: ./]
--helpz Show help and usage information
ksail connect
Description:
Connect to a cluster with K9s
Usage:
ksail connect [options]
Options:
-k, --kubeconfig <kubeconfig> Path to kubeconfig file. [default: ~/.kube/config]
-c, --context <context> The kubernetes context to use. [default: kind-ksail-default]
-e, --editor <Nano|Vim> Editor to use. [default: Nano]
--helpz Show help and usage information
ksail gen
Description:
Generate a resource
Usage:
ksail gen [command] [options]
Options:
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
Commands:
cert-manager Generate a CertManager resource.
config Generate a configuration file.
flux Generate a Flux resource.
kustomize Generate a Kustomize resource.
native Generate a native Kubernetes resource.
ksail gen cert-manager
Description:
Generate a CertManager resource.
Usage:
ksail gen cert-manager [command] [options]
Options:
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
Commands:
certificate Generate a 'cert-manager.io/v1/Certificate' resource.
cluster-issuer Generate a 'cert-manager.io/v1/ClusterIssuer' resource.
ksail gen cert-manager certificate
Description:
Generate a 'cert-manager.io/v1/Certificate' resource.
Usage:
ksail gen cert-manager certificate [options]
Options:
-o, --output <output> A file or directory path. [default: ./certificate.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen cert-manager cluster-issuer
Description:
Generate a 'cert-manager.io/v1/ClusterIssuer' resource.
Usage:
ksail gen cert-manager cluster-issuer [options]
Options:
-o, --output <output> A file or directory path. [default: ./cluster-issuer.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen config
Description:
Generate a configuration file.
Usage:
ksail gen config [command] [options]
Options:
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
Commands:
k3d Generate a 'k3d.io/v1alpha5/Simple' resource.
ksail Generate a 'ksail.io/v1alpha1/Cluster' resource.
sops Generate a SOPS configuration file.
ksail gen config k3d
Description:
Generate a 'k3d.io/v1alpha5/Simple' resource.
Usage:
ksail gen config k3d [options]
Options:
-o, --output <output> A file or directory path. [default: ./k3d.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen config ksail
Description:
Generate a 'ksail.io/v1alpha1/Cluster' resource.
Usage:
ksail gen config ksail [options]
Options:
-o, --output <output> A file or directory path. [default: ./ksail.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen config sops
Description:
Generate a SOPS configuration file.
Usage:
ksail gen config sops [options]
Options:
-o, --output <output> A file or directory path. [default: ./.sops.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen flux
Description:
Generate a Flux resource.
Usage:
ksail gen flux [command] [options]
Options:
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
Commands:
helm-release Generate a 'helm.toolkit.fluxcd.io/v2/HelmRelease' resource.
helm-repository Generate a 'source.toolkit.fluxcd.io/v1/HelmRepository' resource.
kustomization Generate a 'kustomize.toolkit.fluxcd.io/v1/Kustomization' resource.
ksail gen flux helm-release
Description:
Generate a 'helm.toolkit.fluxcd.io/v2/HelmRelease' resource.
Usage:
ksail gen flux helm-release [options]
Options:
-o, --output <output> A file or directory path. [default: ./helm-release.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen flux helm-repository
Description:
Generate a 'source.toolkit.fluxcd.io/v1/HelmRepository' resource.
Usage:
ksail gen flux helm-repository [options]
Options:
-o, --output <output> A file or directory path. [default: ./helm-repository.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen flux kustomization
Description:
Generate a 'kustomize.toolkit.fluxcd.io/v1/Kustomization' resource.
Usage:
ksail gen flux kustomization [options]
Options:
-o, --output <output> A file or directory path. [default: ./flux-kustomization.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen kustomize
Description:
Generate a Kustomize resource.
Usage:
ksail gen kustomize [command] [options]
Options:
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
Commands:
component Generate a 'kustomize.config.k8s.io/v1alpha1/Component' resource.
kustomization Generate a 'kustomize.config.k8s.io/v1beta1/Kustomization' resource.
ksail gen kustomize component
Description:
Generate a 'kustomize.config.k8s.io/v1alpha1/Component' resource.
Usage:
ksail gen kustomize component [options]
Options:
-o, --output <output> A file or directory path. [default: ./kustomization.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen kustomize kustomization
Description:
Generate a 'kustomize.config.k8s.io/v1beta1/Kustomization' resource.
Usage:
ksail gen kustomize kustomization [options]
Options:
-o, --output <output> A file or directory path. [default: ./kustomization.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native
Description:
Generate a native Kubernetes resource.
Usage:
ksail gen native [command] [options]
Options:
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
Commands:
cluster-role-binding Generate a 'rbac.authorization.k8s.io/v1/ClusterRoleBinding' resource.
cluster-role Generate a 'rbac.authorization.k8s.io/v1/ClusterRole' resource.
namespace Generate a 'core/v1/Namespace' resource.
network-policy Generate a 'networking.k8s.io/v1/NetworkPolicy' resource.
persistent-volume Generate a 'core/v1/PersistentVolume' resource.
resource-quota Generate a 'core/v1/ResourceQuota' resource.
role-binding Generate a 'rbac.authorization.k8s.io/v1/RoleBinding' resource.
role Generate a 'rbac.authorization.k8s.io/v1/Role' resource.
service-account Generate a 'core/v1/ServiceAccount' resource.
config-map Generate a 'core/v1/ConfigMap' resource.
persistent-volume-claim Generate a 'core/v1/PersistentVolumeClaim' resource.
secret Generate a 'core/v1/Secret' resource.
horizontal-pod-autoscaler Generate a 'autoscaling/v2/HorizontalPodAutoscaler' resource.
pod-disruption-budget Generate a 'policy/v1/PodDisruptionBudget' resource.
priority-class Generate a 'scheduling.k8s.io/v1/PriorityClass' resource.
ingress Generate a 'networking.k8s.io/v1/Ingress' resource.
service Generate a 'core/v1/Service' resource.
cron-job Generate a 'batch/v1/CronJob' resource.
daemon-set Generate a 'apps/v1/DaemonSet' resource.
deployment Generate a 'apps/v1/Deployment' resource.
job Generate a 'batch/v1/Job' resource.
stateful-set Generate a 'apps/v1/StatefulSet' resource.
ksail gen native cluster-role-binding
Description:
Generate a 'rbac.authorization.k8s.io/v1/ClusterRoleBinding' resource.
Usage:
ksail gen native cluster-role-binding [options]
Options:
-o, --output <output> A file or directory path. [default: ./cluster-role-binding.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native cluster-role
Description:
Generate a 'rbac.authorization.k8s.io/v1/ClusterRole' resource.
Usage:
ksail gen native cluster-role [options]
Options:
-o, --output <output> A file or directory path. [default: ./cluster-role.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native namespace
Description:
Generate a 'core/v1/Namespace' resource.
Usage:
ksail gen native namespace [options]
Options:
-o, --output <output> A file or directory path. [default: ./namespace.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native network-policy
Description:
Generate a 'networking.k8s.io/v1/NetworkPolicy' resource.
Usage:
ksail gen native network-policy [options]
Options:
-o, --output <output> A file or directory path. [default: ./network-policy.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native persistent-volume
Description:
Generate a 'core/v1/PersistentVolume' resource.
Usage:
ksail gen native persistent-volume [options]
Options:
-o, --output <output> A file or directory path. [default: ./persistent-volume.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native resource-quota
Description:
Generate a 'core/v1/ResourceQuota' resource.
Usage:
ksail gen native resource-quota [options]
Options:
-o, --output <output> A file or directory path. [default: ./resource-quota.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native role-binding
Description:
Generate a 'rbac.authorization.k8s.io/v1/RoleBinding' resource.
Usage:
ksail gen native role-binding [options]
Options:
-o, --output <output> A file or directory path. [default: ./role-binding.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native role
Description:
Generate a 'rbac.authorization.k8s.io/v1/Role' resource.
Usage:
ksail gen native role [options]
Options:
-o, --output <output> A file or directory path. [default: ./role.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native service-account
Description:
Generate a 'core/v1/ServiceAccount' resource.
Usage:
ksail gen native service-account [options]
Options:
-o, --output <output> A file or directory path. [default: ./service-account.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native config-map
Description:
Generate a 'core/v1/ConfigMap' resource.
Usage:
ksail gen native config-map [options]
Options:
-o, --output <output> A file or directory path. [default: ./config-map.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native persistent-volume-claim
Description:
Generate a 'core/v1/PersistentVolumeClaim' resource.
Usage:
ksail gen native persistent-volume-claim [options]
Options:
-o, --output <output> A file or directory path. [default: ./persistent-volume-claim.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native secret
Description:
Generate a 'core/v1/Secret' resource.
Usage:
ksail gen native secret [options]
Options:
-o, --output <output> A file or directory path. [default: ./secret.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native horizontal-pod-autoscaler
Description:
Generate a 'autoscaling/v2/HorizontalPodAutoscaler' resource.
Usage:
ksail gen native horizontal-pod-autoscaler [options]
Options:
-o, --output <output> A file or directory path. [default: ./horizontal-pod-autoscaler.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native pod-disruption-budget
Description:
Generate a 'policy/v1/PodDisruptionBudget' resource.
Usage:
ksail gen native pod-disruption-budget [options]
Options:
-o, --output <output> A file or directory path. [default: ./pod-disruption-budget.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native priority-class
Description:
Generate a 'scheduling.k8s.io/v1/PriorityClass' resource.
Usage:
ksail gen native priority-class [options]
Options:
-o, --output <output> A file or directory path. [default: ./priority-class.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native ingress
Description:
Generate a 'networking.k8s.io/v1/Ingress' resource.
Usage:
ksail gen native ingress [options]
Options:
-o, --output <output> A file or directory path. [default: ./ingress.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native service
Description:
Generate a 'core/v1/Service' resource.
Usage:
ksail gen native service [options]
Options:
-o, --output <output> A file or directory path. [default: ./service.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native cron-job
Description:
Generate a 'batch/v1/CronJob' resource.
Usage:
ksail gen native cron-job [options]
Options:
-o, --output <output> A file or directory path. [default: ./cron-job.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native daemon-set
Description:
Generate a 'apps/v1/DaemonSet' resource.
Usage:
ksail gen native daemon-set [options]
Options:
-o, --output <output> A file or directory path. [default: ./daemon-set.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native deployment
Description:
Generate a 'apps/v1/Deployment' resource.
Usage:
ksail gen native deployment [options]
Options:
-o, --output <output> A file or directory path. [default: ./deployment.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native job
Description:
Generate a 'batch/v1/Job' resource.
Usage:
ksail gen native job [options]
Options:
-o, --output <output> A file or directory path. [default: ./job.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail gen native stateful-set
Description:
Generate a 'apps/v1/StatefulSet' resource.
Usage:
ksail gen native stateful-set [options]
Options:
-o, --output <output> A file or directory path. [default: ./stateful-set.yaml]
--overwrite Overwrite existing files. [default: False]
--helpz Show help and usage information
ksail secrets
Description:
Manage secrets
Usage:
ksail secrets [command] [options]
Options:
--helpz Show help and usage information
Commands:
encrypt <path> Encrypt a file
decrypt <path> Decrypt a file
edit <path> Edit an encrypted file
add Add a new encryption key
rm <public-key> Remove an existing encryption key
list List keys
import <key> Import a key from stdin or a file
export <public-key> Export a key to a file
ksail secrets encrypt
Description:
Encrypt a file
Usage:
ksail secrets encrypt <path> [options]
Arguments:
<path> The path to the file to encrypt.
Options:
-pk, --public-key <public-key> The public key. [default: ]
-ip, --in-place In-place decryption/encryption. [default: False]
-o, --output <output> A file or directory path. []
--helpz Show help and usage information
ksail secrets decrypt
Description:
Decrypt a file
Usage:
ksail secrets decrypt <path> [options]
Arguments:
<path> The path to the file to decrypt.
Options:
-ip, --in-place In-place decryption/encryption. [default: False]
-o, --output <output> A file or directory path. []
--helpz Show help and usage information
ksail secrets edit
Description:
Edit an encrypted file
Usage:
ksail secrets edit <path> [options]
Arguments:
<path> The path to the file to edit.
Options:
-e, --editor <Nano|Vim> Editor to use. [default: Nano]
--helpz Show help and usage information
ksail secrets add
Description:
Add a new encryption key
Usage:
ksail secrets add [options]
Options:
--helpz Show help and usage information
ksail secrets rm
Description:
Remove an existing encryption key
Usage:
ksail secrets rm <public-key> [options]
Arguments:
<public-key> Public key matching existing encryption key
Options:
--helpz Show help and usage information
ksail secrets list
Description:
List keys
Usage:
ksail secrets list [options]
Options:
-spk, --show-private-keys Show private keys. [default: False]
-a, --all Show all keys. [default: False]
--helpz Show help and usage information
ksail secrets import
Description:
Import a key from stdin or a file
Usage:
ksail secrets import <key> [options]
Arguments:
<key> The encryption key to import
Options:
--helpz Show help and usage information
ksail secrets export
Description:
Export a key to a file
Usage:
ksail secrets export <public-key> [options]
Arguments:
<public-key> The public key for the encryption key to export
Options:
-o, --output <output> A file or directory path. []
--helpz Show help and usage information
ksail run
Description:
Run a command
Usage:
ksail run [command] [options]
Options:
--helpz Show help and usage information
Commands:
age-keygen <args> Run 'age-keygen' command
cilium <args> Run 'cilium' command
flux <args> Run 'flux' command
helm <args> Run 'helm' command
k3d <args> Run 'k3d' command
k9s <args> Run 'k9s' command
kind <args> Run 'kind' command
kubeconform <args> Run 'kubeconform' command
kubectl <args> Run 'kubectl' command
kustomize <args> Run 'kustomize' command
sops <args> Run 'sops' command