GET STARTED

Install Dependencies

Karate requires Java 17 or higher and a build tool (Maven or Gradle).

Step 1: Verify Java Installation

Run in your terminal or command prompt:

Terminal

java -version

You should see a version of 17 or higher. If not, install Java as described below.

Step 2: Install Java

macOS

Using Homebrew:

Terminal

# Install Java 17
brew install openjdk@17

# Add Java to your PATH (append to ~/.zshrc)
export PATH="/opt/homebrew/opt/openjdk@17/bin:$PATH"
export JAVA_HOME=$(/usr/libexec/java_home -v 17)

# Reload your shell
source ~/.zshrc

Manual download:

• Oracle JDK

Windows

Using winget (Windows 10/11):

Command Prompt

winget install EclipseAdoptium.Temurin.17.JDK

Using Chocolatey:

PowerShell (Admin)

choco install temurin17

Manual download:

• Oracle JDK

During manual installation, ensure you tick the option to set JAVA_HOME.

Linux

Debian/Ubuntu:

Terminal

sudo apt update
sudo apt install openjdk-17-jdk

Other distributions: use your package manager (e.g., dnf, yum, zypper) or download Oracle JDK.

Verify installation:

Terminal

java -version

Step 3: Install a Build Tool

Maven

macOS

Using Homebrew:

Terminal

brew install maven

Manual download: Apache Maven

Windows

Using winget:

Command Prompt

winget install Apache.Maven

Using Chocolatey:

PowerShell (Admin)

choco install maven

Manual download: Apache Maven

Linux

Using apt:

Terminal

sudo apt install maven

Manual download: Apache Maven

Verify installation:

Terminal

mvn -v

Gradle

macOS

Using Homebrew:

Terminal

brew install gradle

Manual download: Gradle

Windows

Using winget:

Command Prompt

winget install Gradle.Gradle

Using Chocolatey:

PowerShell (Admin)

choco install gradle

Manual download: Gradle

Linux

Using apt:

Terminal

sudo apt install gradle

Manual download: Gradle

Verify installation:

Terminal

gradle -v

Next Steps

With Java and your build tool installed, proceed to the Quick Start guide to set up Karate in your project.