Files
sdkman-cli/README.md
2017-01-15 22:20:49 +01:00

61 lines
2.5 KiB
Markdown

# SDKMAN! CLI
### The Software Development Kit Manager Command Line Interface
[![Build Status](https://travis-ci.org/sdkman/sdkman-cli.svg?branch=master)](https://travis-ci.org/sdkman/sdkman-cli)
[![Latest Version](https://api.bintray.com/packages/sdkman/generic/sdkman-cli/images/download.svg) ](https://bintray.com/sdkman/generic/sdkman-cli/_latestVersion)
[![Gitter](https://badges.gitter.im/sdkman/user-issues.png)](https://gitter.im/sdkman/user-issues)
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](http://sdkman.io).
User issues can be raised on our [Gitter Channel](https://gitter.im/sdkman/user-issues).
After confirming that indeed a new bug was found, an Issue may be raised (as well as any new feature requests) on
the [GitHub Issue Tracker](https://github.com/sdkman/sdkman-cli/issues).
Unfortunately we will close any Github Issues that have not followed this process.
## 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.
## Running the Cucumber Features
All SDKMAN's BDD tests 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
__Please ensure that the JAVA_HOME environment variable is set to JDK 1.8 on your system!__
Mac users can add the following line to their `~/.bash_profile` file to set this variable:
export JAVA_HOME=$(/usr/libexec/java_home -v1.8)
### 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