Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gatling/gatling.io-doc/llms.txt

Use this file to discover all available pages before exploring further.

Gatling can be installed and run entirely on your own machine or CI infrastructure, independent of Gatling Enterprise’s cloud control plane. The open-source distribution is the foundation on which test scripts are written and validated locally before being packaged and deployed to Gatling Enterprise Edition for scaled cloud execution. This page covers the available installation methods, prerequisites, IDE configuration, and how to run your first simulation locally.

Prerequisites

JVM languages (Java, Kotlin, Scala)

Gatling runs on the Java Virtual Machine. Before installing, ensure you have:
  • Java: 64-bit OpenJDK LTS, versions 11 through 25. 32-bit JVMs and OpenJ9 are not supported. The Azul JDK is recommended.
  • Language support: Java, Kotlin, and Scala are supported from Gatling 3.7 onward. Earlier versions support Scala only.
Unless you are an experienced Scala or Kotlin developer, choose Java as your simulation language.

JavaScript / TypeScript

Gatling’s JavaScript SDK requires:
  • Node.js v24 or later (LTS versions only)
  • npm v11 or later (bundled with Node.js)
The JavaScript SDK currently covers the HTTP protocol only. Other Gatling protocols (JMS, MQTT, etc.) require the JVM distribution.

Installation methods

IDE setup

IntelliJ IDEA

IntelliJ IDEA Community Edition includes Java, Kotlin, Maven, and Gradle support by default. For Scala and sbt, install the Scala plugin (available in the Community Edition). Increase the Scala compiler stack size to avoid StackOverflowError during compilation:
  • Open Settings → Build, Execution, Deployment → Compiler → Scala Compiler
  • Set the Xss JVM option to 100M

VS Code

Install the appropriate language extension for your chosen language:

Running your first simulation locally

The demo projects include a pre-configured simulation you can run immediately to experience Gatling’s reports feature.
./mvnw gatling:test

Starting the Gatling Recorder

The Gatling Recorder captures browser interactions and converts them into a Gatling script.
./mvnw gatling:recorder

JAVA_HOME considerations

Gatling launch scripts and the Maven plugin honour the JAVA_HOME environment variable when set. If you encounter errors like Unsupported major.minor version, verify that JAVA_HOME points to a supported JDK (11–25) and that it matches the JDK reported by java -version.

Next steps

After validating your simulation locally, deploy it to Gatling Enterprise Edition for scaled, multi-location cloud runs:

Package Generation

Learn how to package your simulation for upload to Gatling Enterprise.

Test as Code

Create and configure a test-as-code run in the Enterprise UI.

Build docs developers (and LLMs) love