Jkk

The aim of this project is to create a git-like tool to be integrated in the development workflow of an everyday developer.

We all know how frustrating can be leaving our beloved shell to check on a 2005-white-background Jenkins dashboard how build is going on. Sometimes, one would just like to know if the build for the last commit passed or not. Jkk wants to smooth this task by integrating the build information directly in the developer workflow.

If you want to get in touch with the developers or if you have any questions you can find us in our official Discord server!

Installing

Install Pre-built Packages

The easiest way to run this project is to download a pre-built binary. You can find binaries of our latest release here. At the moment it supports:

• Arch Linux
• Fedora 31
• openSUSE Tumbleweed
• Ubuntu 19.10

From source

The project is configured using Gradle. It comes with the "application" plugin that allows to easily generate a ready-to-use jar, wrapped up by a shell script.

• Clone the repo
• Use this command to generate a runnable cli:

  ./gradlew installDist

You will find everything under ./build/install/jkk, and the executable will be in under the bin directory.

From the AUR

If you're lucky enough to use Arch Linux, someone has an AUR package just for you!

• git clone https://aur.archlinux.org/jkk-git.git
• cd jkk-git
• makepkg -si

Documentation

If you are searching for code documentation, you can find it in the source files 😉. If you are searching for user documentation instead, you can find it in our wiki. No luck? Open an issue and tell us what is missing!

License

The software comes under a GPL 3 or later license. This means you can redistribute the source code using the same license as long as you want, provided you keep it open source.