Documentation
¶
Overview ¶
gendocs regenerates docs/commands.md from the live cobra command tree.
Usage (from repo root):
go run ./cmd/gendocs # write docs/commands.md go run ./cmd/gendocs -o /tmp/cmd.md # custom path go run ./cmd/gendocs -check # exit non-zero if the file would change
CI uses -check on every PR to fail when somebody adds a command without regenerating the reference. The release workflow uses the default mode to ship a fresh page alongside the binary.
Click to show internal directories.
Click to hide internal directories.