konghelp

README

kong-help

Library to generate pretty help output for Go CLI's that use alecthomas/kong. Help output based heavily on the format used by rendercv.

Basic Example

package main

import (
	"github.com/alecthomas/kong"
	konghelp "github.com/ohhfishal/kong-help"
	"os"
)

type CMD struct {
    // ...
}

func main() {
	var cli CMD
	kongCtx := kong.Parse(
		&cli,
        /* Just add this new option to kong.Parse */
		konghelp.Help(),
	)

	if err := kongCtx.Run(); err != nil {
		fmt.Fprintln(os.Stderr, err.Error())
		os.Exit(1)
	}
}

A more detail example can be found in _examples/readme/main.go.

Upcoming

• Better examples/docs
• Support for command grouping
• Support for all kong.HelpOption's
• Help formatting options? (IE control of styling)
• Tests

Documentation

Index

• Constants
• Variables
• func AggregateIntoLines(parts []string, maxWidth int) ([]string, error)
• func Help(options ...Options) kong.Option
• func NewPrettyPrinter(printOpts Options) kong.HelpPrinter
• func PrettyValueFormatter(formatter kong.HelpValueFormatter) kong.HelpValueFormatter
• func TruncateWithSuffix(line string, width int, suffix string) string
• func Visible(str string) string
• func VisibleLen(str string) int
• type Options

Constants

const DefaultWidth = 80

DefaultWidth is the fallback width if it can not be automatically determined.

Variables

var ColorCommand = color.New(color.FgCyan).SprintFunc()

var ColorDefault = color.New(color.FgMagenta).SprintFunc()

var ColorExample = color.New(color.FgYellow).SprintFunc()

TODO: Make these configurable

var ColorGroup = color.New(color.FgBlue).Add(color.Underline).SprintFunc()

var ColorLow = color.HiBlackString

var ColorPlaceHolder = ColorDefault

var ColorRequired = color.New(color.FgRed).SprintFunc()

var ColorType = ColorExample

Functions

func AggregateIntoLines

func AggregateIntoLines(parts []string, maxWidth int) ([]string, error)

func Help

func Help(options ...Options) kong.Option

func NewPrettyPrinter

func NewPrettyPrinter(printOpts Options) kong.HelpPrinter

func PrettyValueFormatter

func PrettyValueFormatter(formatter kong.HelpValueFormatter) kong.HelpValueFormatter

func TruncateWithSuffix

func TruncateWithSuffix(line string, width int, suffix string) string

func Visible

func Visible(str string) string

func VisibleLen

func VisibleLen(str string) int

Calculates the length of a string only counting visible characters

Types

type Options

type Options struct {
	// UseWidth controls the max width printed.
	// If UseWidth is 0, stdout's width is used instead if a terminal, otherwise 80.
	UseWidth int
	// contains filtered or unexported fields
}