kommand

This library allows you to easily create kotlin-style wrappers for command line functions. It encapsulates java.lang.ProcessBuilder and also handles the usage of sudo for a command.

Example

Lets create an example for the echo cli command.

Create a configuration for the various parameters that you want to support.

data class EchoConfig(
    var commandExecutor: CommandExecutor = JavaProcessBuilder(),
    var suppressTrailingNewlineCharacters: Boolean = false,
)

Create a wrapper for the function

fun echo(message: String, config: EchoConfig.() -> Unit = { }): String {
    val currentConfig = EchoConfig().apply(config)

    require(message.isNotBlank()) { "Message must not be blank." }

    val cmdBuilder = mutableListOf("echo")

    if (currentConfig.suppressTrailingNewlineCharacters) {
        cmdBuilder.add("-n")
    }

    cmdBuilder.add(message)

    return currentConfig.commandExecutor.executeCmd(cmdBuilder)
}

Now you can call the function using defaults:

fun main() {
    val result = echo("hello world")
    println(result)
}

Or alternatively call it with parameters:

fun main() {
    val result = echo("hello world") {
        suppressTrailingNewlineCharacters = true
    }
    println(result)
}