Skip to content

CLI Installation

Windows

iex "& { $(iwr -useb https://jeka.dev/install.ps1) } install check"

SDKMAN!

sdk install jeka

MacOS and Linux

curl -sL https://jeka.dev/install.sh | $(echo $0) -s - install check

Note

JeKa requires bash, curl, and unzip, usually available on macOS and Linux. On Ubuntu, install tools with: 

apt-get update && apt-get install -y curl unzip git gcc zlib1g-dev

Manual installation

The manual installation is straightforward and may help when script installation fails.

  • Download latest JeKa distrib from maven central and download file named jeka-core-xxx-distrib.zip.
  • Unzip the content of the zip file and copy the content of the bin directory to [USER HOME]/.jeka/bin.
  • Add [USER HOME]/.jeka/bin and [USER HOME]/.jeka/apps to your PATH environment variable.

Post Install

Installation via scripts may include a sanity check that triggers a JDK download (because of the check argument passed to the install script).

Once installed, you will rarely need to upgrade, as JeKa will execute the JeKa version specified in the application to run. However, you'll be able to upgrade your base install by executing: 

jeka-update

Open a new terminal session and execute the following command to access JeKa help: 

jeka --help

Docker Image - Zero Install

JeKa can be executed using the Docker image jekadev/jeka.

To do this, execute:

  • Linux/macOS: docker run -v $HOME/.jeka/cache4c:/cache -v .:/workdir jekadev/jeka [JEKA ARGUMENTS]
  • Windows PowerShell: docker run -v ${HOME}\.jeka\cache4c:/cache -v ${PWD}:/workdir jekadev/jeka [JEKA ARGUMENTS]
  • Windows cmd: docker run -v %USERPROFILE%\.jeka\cache4c:/cache -v %cd%:/workdir jekadev/jeka [JEKA ARGUMENTS]

Note

-v $HOME/.jeka/cache4c:/cache

Tells JeKa to use a specific cache when running with a container, as JDK or other tools cached by JeKa may differ from the ones used by the host system.

-v .:/workdir

Lets JeKa operate in the current directory of the host machine.

[JEKA ARGUMENTS]

Stands for regular JeKa arguments you would pass to JeKa command line such as project: pack or --help.