https://github.com/christian-draeger/kotlin-cli-example

https://github.com/christian-draeger/kotlin-cli-example

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/christian-draeger/kotlin-cli-example
• Owner: christian-draeger
• License: mit
• Created: 2019-11-19T14:33:41.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-19T18:28:40.000Z (almost 6 years ago)
• Last Synced: 2025-05-14T08:48:42.683Z (5 months ago)
• Language: Kotlin
• Size: 510 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kotlin-cli-example

This example project demonstrates how to build a CLI (command line interface) application with Kotlin

### Artifacts

The gradle build will produce a fatjar (jar that includes all its dependencies) and a native-image.

#### Jar

To **build the fat-jar** run:

    ./gradlew build

Afterwards the fat-jar can be found und `build/libs`-folder. 

To **execute the fat-jar** run:

    java -jar koltin-cli-example-all.jar

#### Native Binary

##### Prerequisites

* GraalVM installed

    * e.g. via [sdk-man](https://sdkman.io/install): `sdk use java 19.2.1-grl`

* native-image installed

    * simply run `gu install native-image`

To **build the native binary** run:

    ./gradlew nativeImage

The native-image (binary) can be found und `build/native-image`-folder.

To execute the native binary

    ./mycli

    

----

## Implemented Examples

There are a few use-cases implemented to show-case different behaviours a CLI can fulfill.

### Interactive Example

A little example of a CLI that will prompt fields to input data.

For source-code see [SayHello.kt](src/main/kotlin/commands/SayHello.kt)

To use the fatjar run:

    java -jar kotlin-cli-example-all.jar say-hello

    

To use the native binary run:

    ./mycli say-hello

    

![say-hello-example](examples/say-hello-example.gif)

----

### Grab data from WWW

A little Example that demonstrates how to make a http request and print received data to console.

For source-code see [LinkCrawler.kt](src/main/kotlin/commands/LinkCrawler.kt)

To use the fatjar run:

    java -jar kotlin-cli-example-all.jar link-crawler https://kotlinlang.org/docs/reference/

    

To use the native binary run:

    ./mycli link-crawler https://kotlinlang.org/docs/reference/

    

![link-crawler-example](examples/link-crawler-example.gif)