Ruby runner for Gauge.
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.bundle Added debugging support getgauge/gauge-vscode#167. Mar 5, 2018
gauge-proto @ 5dc343c Renamed field failedScreenshot to failureScreenshot Aug 13, 2018
lib Added null check for custom messages #99 Nov 30, 2018
skel Added comments in .gitignore Sep 5, 2017
spec Added null check for custom messages #99 Nov 30, 2018
.gitignore Added debugging support getgauge/gauge-vscode#167. Mar 5, 2018
.gitmodules Adding gauge proto as sub-module Dec 1, 2014
.rspec introduced simplecov for coverage Feb 4, 2016
.ruby-gemset set ruby to 2.2, gemset as gauge Feb 10, 2015
.ruby-version bumped up to use ruby 2.3 Feb 5, 2016
.travis.yml Install screenshot plugin May 21, 2018 updating cla links Nov 7, 2018
COPYING include license in repository Feb 6, 2015
Gemfile add rake to gemfile Oct 6, 2017
Gemfile.lock Bumping up version to 0.5.2 for further development. Jun 18, 2018 fixing the markdown issues Mar 9, 2018
Rakefile update protoc dependency Apr 5, 2018
gauge-ruby.gemspec sendig file diff to gauge. Apr 23, 2018
gauge-ruby.go starting gauge_runtime with bundle getgauge/gauge-vscode#85 #47 Jan 11, 2018
genproto.bat change copyright to reflect 2015 Feb 6, 2015 Added grpc service for lsp Apr 5, 2018
make.go Adding .gitignore file while initializing, getgauge/gauge#668 Jun 12, 2017 fixing links Nov 7, 2018
ruby.json Bumping up version to 0.5.2 for further development. Jun 18, 2018


Build Status Gem Download Nightly

This project adds ruby language plugin for gauge.

The plugin is authored in Ruby. It contains a launcher component (gauge-ruby.go) written in golang which is used to start the plugin from gauge.

Getting started



gauge install ruby

Create a gauge-java project

gauge init java

Run tests

gauge run specs

Alternate Installation options

Install specific version

  • Installing specific version
gauge install ruby --version 0.4.2

Offline installation

gauge install ruby --file

Nightly installation

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

Once you have the downloaded nightly, install using:

gauge install ruby -f

Build from Source


Run bundle install to install all required gems.

Running bundle exec rake -T should give the list of all tasks available. Below sections detail some commonly used tasks.


To build and the gauge-ruby executable for current platform use:

bundle exec rake compile

To build and the gauge-ruby for all supported platforms use:

bundle exec rake xcompile

After compiling

TO install the use:

bundle exec rake install

To install gauge-ruby plugin use (Note, this will uninstall gauge-ruby before installing the compiled version):

bundle exec rake force_install

Installing to a CUSTOM_LOCATION

bundle exec rake force_install[CUSTOM_LOCATION]
Creating distributable

Note: Run after compiling

bundle exec rake package

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

bundle exec rake package_all

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


GNU Public License version 3.0 Gauge-Ruby is released under GNU Public License version 3.0


Copyright 2015 ThoughtWorks, Inc.