SDKMAN is a tool for managing parallel Versions of multiple Software Development Kits on any Unix based system. It provides a convenient command line interface for installing, switching, removing and listing Candidates.

See documentation on the SDKMAN! website.

Installation

Open your favourite terminal and enter the following:

$ curl -s https://get.sdkman.io | bash

If the environment needs tweaking for SDKMAN to be installed, the installer will prompt you accordingly and ask you to restart.

Contributions

Bugs and New Features

User Issues can be raised in our Gitter Room for User Issues. Similarly, new features can be discussed in our CLI Development Room.

After accepting a new feature or confirming that a bug was found, an Issue may be raised filling in the provided Issue Template on the GitHub Issue Tracker.

Unfortunately we will close any Github Issues that have not followed this process.

Pull Requests

Pull requests are always very welcome, but require an initial discussion on Gitter followed by a Github Issue as described above. Once this has been completed, a PR can be raised and linked to the Github Issue. All PRs should be accompanied by a passing test(s) proving it's validity (where feasible). The feasibility of the test will emerge in the initial discussions on Gitter and in the Github Issue.

Running the Cucumber Features

All SDKMAN's BDD tests describing the CLI behaviour are written in Cucumber and can be found under src/test/cucumber/sdkman. These can be run with Gradle by running the following command:

$ ./gradlew test

To perform development, you will need to have a JDK 8 or higher installed which can be obtained by running the following after installing SDKMAN:

$ sdk install java

Using Docker for tests

You can run the tests in a Docker container to guarantee a clean test environment.

$ docker build --tag=sdkman-cli/gradle .
$ docker run --rm -it sdkman-cli/gradle test

By running the following command, you don't need to wait for downloading Gradle wrapper and other dependencies. The test reports can be found under the local build directory.

$ docker run --rm -it -v $PWD:/usr/src/app -v $HOME/.gradle:/root/.gradle sdkman-cli/gradle test

Local Installation

To install SDKMAN locally running against your local server, run the following commands:

$ ./gradlew install
$ source ~/.sdkman/bin/sdkman-init.sh

Or run install locally with Production configuration:

$ ./gradlew -Penv=production install
$ source ~/.sdkman/bin/sdkman-init.sh