optionshelp

package
v0.0.0-...-2bb223d Latest Latest
Warning

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

Go to latest
Published: Feb 9, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package optionshelp produces markdown documentation for options and creates CLI commands utilizing this documentation.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Command

func Command(name, short string, groups []*options.Group, format *mdfmt.Formatter) *cobra.Command

Command creates a command to display help for the given options.

func LazyCommand

func LazyCommand(name, short string, groupFunc func() []*options.Group, format *mdfmt.Formatter) *cobra.Command

LazyCommand creates a command to display help for the given options.

func MarkdownDoc

func MarkdownDoc(groups []*options.Group) (docs string, err error)

MarkdownDoc produces markdown documentation for the given options.

func SetTemplate

func SetTemplate(tmpl string) error

SetTemplate overrides the default template.

Types

This section is empty.

Jump to

Keyboard shortcuts

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