Skip to content

kx describe

Shows full kubectl describe output for one or more indexed resources, printing each under its own Kind/name banner.

A flag kx doesn’t know is refused; put it after -- to pass it through to kubectl.

Usage

kx describe [OPTIONS] <index>... [kubectl flags]

Arguments

ArgumentDescription
<index>...Row number from the current listing, or @name for a mark; kx state or kx mark shows them

Passthrough options

OptionDescription
-A, --all-namespacesIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
--chunk-size int64Return large lists in chunks rather than all at once. Pass 0 to disable.
-f, --filename stringsFilename, directory, or URL to files containing the resource to describe
-k, --kustomize stringProcess the kustomization directory. This flag can’t be used together with -f or -R.
-R, --recursiveProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
-l, --selector stringSelector (label query) to filter on, supports ‘=’, ‘==’, ‘!=’, ‘in’, ’notin’.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints.
--show-eventsIf true, display events related to the described object. Defaults to true for a single object, false for multiple objects and prefix matching.
…kubectl’s global flags too: --context, --kubeconfig, --as and the rest; kubectl options lists them

Global options

OptionDescription
--no-colorDisable styled output
-h, --helpShow this message and exit

Examples

kx describe 1
kx describe 1 3 5
kx describe 1..3
kx describe 3..
kx describe @api
kx describe 1 --show-events=false