CliktConsole

interface CliktConsole

An object that is used by commands and parameters to show text to the user and read input.

By default, stdin and stdout are used, but you can provide an implementation of this interface to Context.console to customize the behavior.

Functions

print
Link copied to clipboard
common
abstract fun print(text: String, error: Boolean)
Show some text to the user.
promptForLine
Link copied to clipboard
common
abstract fun promptForLine(prompt: String, hideInput: Boolean): String?
Show the prompt to the user, and return a line of their response.

Properties

lineSeparator
Link copied to clipboard
common
abstract val lineSeparator: String
The line separator to use.

Inheritors

InteractiveCliktConsole
Link copied to clipboard
NonInteractiveCliktConsole
Link copied to clipboard