github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/site/reference/cli/fn/doc/README.md (about)

     1  ---
     2  title: "Doc"
     3  linkTitle: "doc"
     4  type: docs
     5  description: >
     6    Display the documentation for a function
     7  ---
     8  
     9  <!--mdtogo:Short
    10      Display the documentation for a function
    11  -->
    12  
    13  ### Synopsis
    14  
    15  <!--mdtogo:Long-->
    16  
    17  `kpt fn doc` invokes the function container with `--help` flag.
    18  If the function supports `--help`, it will print the documentation to STDOUT.
    19  Otherwise, it will exit with non-zero exit code and print the error message to STDERR.
    20  
    21  ```
    22  kpt fn doc --image=IMAGE
    23  ```
    24  
    25  #### Flags
    26  
    27  ```
    28  --image, i: (required flag)
    29    Container image of the function e.g. `gcr.io/kpt-fn/set-namespace:v0.1`.
    30    For convenience, if full image path is not specified, `gcr.io/kpt-fn/` is added as default prefix.
    31    e.g. instead of passing `gcr.io/kpt-fn/set-namespace:v0.1` you can pass `set-namespace:v0.1`.
    32  ```
    33  
    34  #### Environment Variables
    35  
    36  ```
    37  KPT_FN_RUNTIME:
    38    The runtime to run kpt functions. It must be one of "docker", "podman" and "nerdctl".
    39  ```
    40  
    41  <!--mdtogo-->
    42  
    43  ### Examples
    44  
    45  <!--mdtogo:Examples-->
    46  
    47  ```shell
    48  # display the documentation for image set-namespace:v0.1.1
    49  kpt fn doc -i set-namespace:v0.1.1
    50  ```
    51  
    52  <!--mdtogo-->