KubeOne(1)

📦 version 1.12.3, in arch rolling

💅 KubeOne(1) — the document glow-up

okay so bestie, welcome to KubeOne(1), and specifically the document command, which is genuinely the most underrated little icon in the whole toolbox. it just... makes docs. for you. no cap. ✨

🎀 NAME 🎀

kubeone-document — generates documentation 💖

that's it. that's the whole vibe. it generates documentation. slay.

🌸 SYNOPSIS 🌸

kubeone document  [flags]

yes the double space is canon, don't come for me 😭

🦋 DESCRIPTION 🦋

so here's the tea: this command generates documentation, and it's giving versatile. you can have your docs as:

  • man pages 👑
  • markdown
  • restructured text docs
  • yaml

pick your fighter. honestly? iconic range.

✨ OPTIONS ✨

  • -h, --help[=false] — help for document. default is false, and like... fair, nobody wants help forced on them 🫶
  • -o, --output-dir="/tmp/" — the directory to populate with documentation. default is "/tmp/", so if you don't say anything it's gonna go dump your gorgeous docs in /tmp/. lowkey chaotic of it but okay 🔥

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these come from the parent kubeone command — they're not document's own thing, they're the family genes 🧬

  • -c, --credentials="" — file to source credentials and secrets from. default is empty, "".
  • -d, --debug[=false] — debug output with stacktrace. default false. turn it on when things get messy and you need the full ✨receipts✨
  • -l, --log-format="text" — format for logging. default "text".
  • -m, --manifest="./kubeone.yaml" — path to the KubeOne config. default "./kubeone.yaml".
  • -t, --tfjson="" — source for terraform output in JSON. here's the breakdown, bestie, listen up:
    • to read from stdin — literally just that, stdin
    • if the path is a file, the contents will be used
    • if the path is a dictionary, terraform output -json is executed in this path

default is empty, "".

  • -v, --verbose[=false] — verbose output. default false. she talks more. we love a talkative queen 💅

🔥 EXAMPLE 🔥

kubeone document man

that's it. that's the whole command. go make man pages, main character 🎀

🌈 SEE ALSO 🌈

  • kubeone(1) — the parent, the origin story, the blueprint 🫶

⭐ HISTORY ⭐

8-Feb-2026 — auto generated by spf13/cobra

ngl, this whole page is auto-generated, so don't come for the prose. the facts are the facts, fr fr 💀

okay bye ily — this page was auto generated by spf13/cobra, dated Feb 2026, and it's a KubeOne(1) situation through and through. go populate /tmp/ with something beautiful, bestie 💖✨🎀🦋🌸💅

📦 where this page comes from