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

ParameterHelp

sealed class ParameterHelp

Functions

formatHelp

abstract fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String = ""): String

Create the full help string.

formatUsage

abstract fun formatUsage(parameters: List<ParameterHelp>, programName: String = ""): String

Create the one-line usage information for a command.

Inheritors

PlaintextHelpFormatter

open class PlaintextHelpFormatter : HelpFormatter