gendocs

command
v0.2.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2026 License: MIT Imports: 5 Imported by: 0

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL