kubeone-document(1)

kubeone-document1

Generates documentation

Usage

kubeone document [flags]

Overview

Documentation can be generated as man pages, markdown, restructured text docs or yaml

Options

-h, --help[=false]
help for document

-o, --output-dir="/tmp/"
Directory to populate with documentation

Options inherited from parent commands

-c, --credentials=""
File to source credentials and secrets from

-d, --debug[=false]
debug output with stacktrace

-l, --log-format="text"
format for logging

-m, --manifest="./kubeone.yaml"
Path to the KubeOne config

-t, --tfjson=""
Source for terraform output in JSON - to read from stdin. If path is a file, contents will be used. If path is a dictionary, terraform output -json is executed in this path

-v, --verbose[=false]
verbose output

Examples

kubeone document man

History

8-Feb-2026 Auto generated by spf13/cobra

From kubeone 1.12.3-3 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.