Argos/onl.ycode.argos/Help

Help

object Help(source)

Utilities for generating formatted help text and error messages.

Note: Most users should use the extension functions Arguments.printUsage and Arguments.printUsageExtended instead of calling methods on this object directly. The extension functions provide a more convenient API and are the recommended entry points.

This object contains the implementation details for help text generation, including formatting, layout, and styling logic.

Functions

Link copied to clipboard
fun printError(args: Arguments, term: Terminal? = null)

Prints error messages followed by basic usage information.

Link copied to clipboard
fun printUsage(args: Arguments, term: Terminal? = null)

Prints comprehensive usage information for the application.

Link copied to clipboard
fun printUsageWithConstraints(args: Arguments, term: Terminal? = null)

Prints extended usage information including constraint details.