cli.kt/README.md

cli-kt

cli-kt is a Kotlin Multiplatform framework for implementing terminal applications.

Targets

Target	Status
JVM	Supported
JavaScript	Supported
Native (Linux)	Supported
Native (Windows)	Not Supported

Installation

Add the following to your build.gradle.kts.

repositories {
    maven("https://git.infendro.com/api/packages/Infendro/maven")
}

dependencies {
    implementation("com.infendro:cli:1.4.0")
}

Usage

fun main(args: Array<String>) = cli("application") {
    execute {
        // define execution of command (e.g., display help)
        println("Usage: application <command> [arguments] [options]")
    }

    // declare command "greet"
    command("greet") {
        // declare arguments
        val speakersArg by Argument.string("speakers").variable(min = 1)

        // declare options
        val greetingOpt by Option.string("greeting", "greet", "g").orElse("Hello")
        val nameOpt by Option.string("name", "n").orNull()

        execute {
            // retrieve the arguments and options
            val speakers by speakersArg
            val greeting by greetingOpt
            val name by nameOpt

            println("${speakers.joinToString()}: $greeting ${name ?: "World"}!")
        }

        // declare more commands...
    }

    // declare fallback command
    fallback("value") { valueArg ->
        execute {
            // retrieve the value used for the fallback command
            val value by valueArg

            println("""command "$value" executed!""")
        }
    }
}.run(args)