clikt / com.github.ajalt.clikt.output / HelpFormatter

HelpFormatter

interface HelpFormatter

Creates help and usage strings for a command.

You can set the formatter for a command when configuring the context.

Types

Name Summary
ParameterHelp sealed class ParameterHelp
Tags Standard tag names for parameter helpobject Tags

Functions

Name Summary
formatHelp Create the full help string.abstract fun formatHelp(prolog:String, epilog:String, parameters:List<ParameterHelp>, programName:String= ""):String
formatUsage Create the one-line usage information for a command.abstract fun formatUsage(parameters:List<ParameterHelp>, programName:String= ""):String

Inheritors

Name Summary
CliktHelpFormatter open class CliktHelpFormatter :HelpFormatter