Kotlin-er CLI
A different take on making command line programs, emphasizing development speed over customization
Status
Auto-deployed to Maven Central after passing unit tests using GitHub Actions
Download
dependencies {
//...
implementation("com.lightningkite:kotliner-cli:1.0.1-SNAPSHOT")
}
Example
import com.lightningkite.kotlinercli.cli
import java.io.File
fun main(args: Array<String>) = cli(args, ::runServer, ::migrate, ::dump, ::deleteItems)
fun runServer(host: String = "0.0.0.0", port: Int = 8080) = println("Running the server at $host on port $port")
fun migrate(version: Int) = println("Upgrading the database")
fun dump(to: File) = println("Dumping to a file")
fun deleteItems(vararg ids: Int) = println("Deleting ${ids.joinToString()}")
$ myProgram
Available commands:
runServer(host: String = ..., port: Int = ...): Unit
migrate(version: Int): Unit
dump(to: File): Unit
deleteItems(ids: IntArray): Unit
$ myProgram runServer --help
runServer
--host: String (optional)
--port: Int (optional)
$ myProgram runServer
Running the server at 0.0.0.0 with port 8000
$ myProgram runServer 127.0.0.0 8080
Running the server at 127.0.0.0 with port 8080
$ myProgram runServer --port 8080
Running the server at 0.0.0.0 with port 8080
$ myProgram deleteItems 1 2 3
Deleting 1, 2, 3
Supported Features
- Primitive Types
- Types with a constructor that takes a
String - Ordered Arguments
- Named Arguments
- Default Arguments
- Variadic Arguments
- Boolean Flags (i.e. using
--flagforflag=true) - Description Annotation - add the annotation to provide more documentation about functions and parameters.
Potential Features
- Annotation to automatically register functions to expose to the CLI
- Questionable security-wise - makes it easy to insert functionality with no obvious connection.
- Compiler plugin to read KDoc for runtime documentation
Deliberately unsupported features
- Object types without a string constructor - No good way to represent in the command line.
- Expose all functions in the command line - would be a potential security problem
68 Jan 6, 2023
60 Dec 24, 2022
9 Oct 21, 2022
326 Dec 23, 2022
2.7k Dec 28, 2022
2 Jan 16, 2022
3.4k Nov 20, 2022
0 Dec 29, 2021
1.5k Dec 30, 2022
28 Oct 17, 2022
349 Jan 9, 2023
0 Jan 3, 2022
0 Apr 24, 2022
66 Dec 28, 2022
3 Sep 24, 2021
119 Dec 27, 2022
193 Nov 20, 2022
40 Dec 27, 2022
84 Oct 31, 2022