Java runner for Gauge
Clone or download


Build status Build Status Maven Central

Gauge-Java Nightly Maven-Gauge-Java Nightly
Download Nightly Download Maven Nightly

This project adds java language plugin for gauge.

Getting started



gauge install java

Create a gauge-java project

gauge init java

Run tests

gauge run specs

Alternate Installation options

Install specific version

  • Installing specific version
gauge install java --version 0.6.5

Offline installation

gauge install java --file

Nightly installation

To install java nightly, download the latest nightly from here.

Once you have the downloaded nightly, install using:

gauge install java -f

Build from source

The plugin is authored in Java. Gauge is authored in golang. These are independent processes talking to each other over TCP on port GAUGE_INTERNAL_PORT (env variable) using Protobuf. This project contains a launcher component (gauge-java.go) written in golang which is used to start the plugin from gauge.

Additional Requirements

Apart from Gauge and Java you will need

go run make.go

For cross platform compilation (launcher)

go run make.go --all-platforms

After compilation

go run make.go --install

Installing to a CUSTOM_LOCATION

go run make.go --install --plugin-prefix CUSTOM_LOCATION
Creating distributable

Note: Run after compiling

go run make.go --distro

For distributable across platforms os, windows and linux for bith x86 and x86_64

go run make.go --distro --all-platforms

New distribution details need to be updated in the java-install.json file in gauge plugin repository for a new verison update.


This program is dual-licensed under:

  1. the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version; or
  2. the Eclipse Public License v1.0. You can redistribute it and/or modify it under the terms of either license.


Copyright 2016 ThoughtWorks, Inc.


This project is supported by YourKit Java Profiler. YourKit supports open source projects with its full-featured Java Profiler, which is used by Gauge Team.