`doc`

Display the documentation for a function

Synopsis #

kpt fn doc invokes the function container with --help flag. If the function supports --help, it will print the documentation to STDOUT. Otherwise, it will exit with non-zero exit code and print the error message to STDERR.

kpt fn doc --image=IMAGE

Flags #

--image, i: (required flag)
  Container image of the function e.g. `ghcr.io/kptdev/krm-functions-catalog/set-namespace:latest`.
  For convenience, if full image path is not specified, `ghcr.io/kptdev/krm-functions-catalog/` is added as default prefix.
  e.g. instead of passing `ghcr.io/kptdev/krm-functions-catalog/set-namespace:latest` you can pass `set-namespace:latest`.

Environment Variables #

KRM_FN_RUNTIME:
  The runtime to run kpt functions. It must be one of "docker", "podman" and "nerdctl".

Examples #

# display the documentation for image set-namespace:latest.1
kpt fn doc -i set-namespace:latest.1

Last modified February 9, 2026: fix: add shell language specifier to fn doc Flags code block (cbc00e9a)