Skip to main content

GET STARTED

Install Dependencies

Karate works on Java LTS. Use Java 21 (recommended) or Java 17. If your project already has a Gradle Wrapper (./gradlew), you don’t need to install Gradle globally.

Step 1: Check Java​

Terminal
java -version

You should see 17 or 21. If not, install Java below.

Step 2: Install Java (LTS)​

Option A — SDKMAN! (recommended)

Terminal
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

sdk install java 21-tem    # or: sdk install java 17-tem
sdk default java 21-tem

java -version

Option B — Homebrew

Terminal
brew install openjdk@21    # or openjdk@17
# Set JAVA_HOME and PATH (works on Intel & Apple Silicon)
echo 'export JAVA_HOME=$(/usr/libexec/java_home -v 21)' >> ~/.zshrc
echo 'export PATH="$JAVA_HOME/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

java -version
Manual download

Step 3: Install a Build Tool (pick one)​

Maven​

SDKMAN!

Terminal
sdk install maven
mvn -v

Homebrew

Terminal
brew install maven
mvn -v

Gradle​

Wrapper preferred

If your project has gradlew, use ./gradlew (no global install required).

SDKMAN!

Terminal
sdk install gradle
gradle -v

Homebrew

Terminal
brew install gradle
gradle -v

Troubleshooting​

  • java: command not found
    Java not on PATH. Set JAVA_HOME and prepend $JAVA_HOME/bin to PATH (macOS/Linux) or %JAVA_HOME%\bin (Windows).

  • Wrong version (e.g., Java 8/11 shows up)
    Remove older Java from PATH or sdk default java 21-tem.

  • mvn / gradle not found
    Reopen the terminal after install, or add their bin folders to PATH.

Next Steps​

With Java and your build tool installed, continue to the Quick Start guide to add Karate to your project.

On This Page