Simplifies writing command line interfaces, offering features like nested commands, type-safe parameters, help output generation, and shell autocomplete scripts. Supports diverse use cases with advanced customization.
Clikt (pronounced "clicked") is a multiplatform Kotlin library that makes writing command line interfaces simple and intuitive. It's the "Command Line Interface for Kotlin".
It is designed to make the process of writing command line tools effortless while supporting a wide variety of use cases and allowing advanced customization when needed.
Clikt has:
What does it look like? Here's a complete example of a simple Clikt program:
class Hello : CliktCommand() {
val count: Int option().int().default().help()
name: String option().prompt().help()
{
repeat(count) {
echo()
}
}
}
= Hello().main(args)
And here's what it looks like when run:
The help page is generated for you:
Errors are also taken care of:
The full documentation can be found on the website.
There are also a number of sample applications. You can run
them with the included runsample script.
Clikt is distributed through Maven Central.
dependencies {
implementation("com.github.ajalt.clikt:clikt:5.1.0")
// optional support for rendering markdown in help messages
implementation("com.github.ajalt.clikt:clikt-markdown:5.1.0")
}
There is also a smaller core module available. See the docs for details.
<artifactId>clikt-jvm</artifactId>Clikt supports most multiplatform targets. See the docs for more information about functionality supported on each target. You'll need to use Gradle 6 or newer.
Sonatype has instructions for consuming snapshots
You'll need to add the Central Portal snapshots repository:
repositories {
maven {
url = uri("https://central.sonatype.com/repository/maven-snapshots/")
}
}
Copyright 2018 AJ Alt
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
Surfaced from shared tags and platforms — no rankings paid for.