KubeRich
Browse documentation

REFERENCE

Command-line reference

Generated from the argument parser for source version 0.1.0. These are registered launch flags, including explicitly unavailable options. See installation, connection setup and in-app commands for usage and limits.

Local kuberich help, kuberich version, kuberich info, and kuberich config init|check|migrate are described in the preferences guide. They do not need a cluster.

Launch options

Option / aliases Description
-h, --help show this help message and exit
--version show program's version number and exit
--config KubeRich preferences YAML (separate from kubeconfig)
--kubeconfig single kubeconfig file (otherwise KUBECONFIG or ~/.kube/config)
--context context to connect (otherwise current-context)
--namespace, -n initial namespace (otherwise the context namespace)
--all-namespaces, -A select all namespaces for this session
--request-timeout API/helper timeout: 0.1-3600 seconds, or ms/s/m/h (default 10s)
--log-file, --logFile local diagnostic log path
--log-level, --logLevel, -l DEBUG, INFO, WARNING, ERROR, or CRITICAL
--refresh, -r periodic table refresh seconds (0.1-3600); watch changes remain live
--readonly block mutations, shell, attach and plugins
--write override the configured read-only preference for this session
--command, -c initial terminal command: po, ctx, ns, status, retry, back, forward, help or quit
--headless hide the application header
--logoless hide the brand in the header
--crumbsless hide the context/namespace scope bar

Recognized options not yet available (exit 4)

Option / aliases Description
--splashless unavailable: startup splash
--invert unavailable: theme inversion
--screen-dump-dir unavailable: screen exports

Session connection overrides

Option / aliases Description
--cluster kubeconfig cluster alias for this invocation
--user kubeconfig auth-info alias for this invocation
--as user/service account to impersonate; server permission required
--as-group impersonation group; repeat to retain multiple groups
--insecure-skip-tls-verify skip TLS verification explicitly; accepts =true or =false
--certificate-authority CA certificate file; enables TLS verification
--client-key client private key file; requires --client-certificate
--client-certificate client certificate file; requires --client-key
--token bearer token override; never included in diagnostics