MordantHelpFormatter

open class MordantHelpFormatter(context: Context, requiredOptionMarker: String? = null, showDefaultValues: Boolean = false, showRequiredTag: Boolean = false) : HelpFormatter

Clikt's default HelpFormatter which uses Mordant to render its output.

To customize help text, you can create a subclass and set it as the helpFormatter on your command's context.

Constructors

constructor(context: Context, requiredOptionMarker: String? = null, showDefaultValues: Boolean = false, showRequiredTag: Boolean = false)

open override fun formatHelp(error: UsageError?, prolog: String, epilog: String, parameters: List<HelpFormatter.ParameterHelp>, programName: String): String

Return a help string to show the user.