Installation¶

Here is the recommended installation steps for all OS.

Windows¶

Using Chocolatey¶

You can install Gauge using Chocolatey as well.

choco install gauge

If you’re upgrading to a newer version, then use the command:

choco upgrade gauge

MacOS¶

The following command installs Gauge.

For this to work, you will need to install homebrew. If you have brew installed then all you need to run is this command; it will download and install Gauge. This requires you to be connected to the Internet.

brew update
brew install gauge

Linux¶

On Debian, Ubuntu¶

Add Gauge’s GPG key, URL to repository list and install Gauge.

sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net --recv-keys 023EDB0B
echo deb https://dl.bintray.com/gauge/gauge-deb stable main | sudo tee -a /etc/apt/sources.list
sudo apt-get update
sudo apt-get install gauge

On RHEL, Fedora, CentOS¶

Create file /etc/yum.repos.d/gauge-stable.repo with the following content:

[gauge-stable]
name=gauge-stable
baseurl=http://dl.bintray.com/gauge/gauge-rpm/gauge-stable
gpgcheck=0
enabled=1

You can use this command to do it in one step:

echo -e "[gauge-stable]\nname=gauge-stable\nbaseurl=http://dl.bintray.com/gauge/gauge-rpm/gauge-stable\ngpgcheck=0\nenabled=1" | sudo tee /etc/yum.repos.d/gauge-stable.repo

Install¶

Install on Fedora:

sudo dnf install gauge

Install on CentOS/RHEL:

sudo yum install gauge

Having trouble with installation? Head over to our Installation FAQ’s.

Alternate Methods¶

Offline Installation¶

Windows/MacOS¶

You can download the Gauge archive. This is a zip file. Extract it to a folder and add this to your system path.

Check the Language runner to install language runner plugins.

Linux¶

Download the zip file. Choose the archive file appropriate for your installation. And run the command below to install Gauge.

unzip gauge-$VERSION-$OS.$ARCH.zip
./install.sh

Gauge can be installed at custom location by using GAUGE_PREFIX env.

Example :-

GAUGE_PREFIX=my/custom/location ./install.sh

Gauge Plugins also can be installed along with gauge ( requires Internet). Set GAUGE_PLUGINS ( comma separated list of plugins) env to install plugins.

Example :-

GAUGE_PLUGINS=java,xml-report ./install.sh

Nightly installation¶

Nightly releases are latest development snapshots of Gauge. They have the latest features being developed, but are unstable. If you want to try out Gauge nightly, do this:

Windows/MacOS¶

Based on your system requirement, you can download the Gauge archive. This is a zip file. Extract it to a folder and add this to your system path.

Linux¶

On Debian, Ubuntu¶

Add Gauge’s GPG key:

sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net --recv-keys 023EDB0B

Run this command to add URL to repository list:

echo deb https://dl.bintray.com/gauge/gauge-deb nightly main | sudo tee -a /etc/apt/sources.list

Install Gauge

sudo apt-get update
sudo apt-get install gauge

On RHEL, Fedora, CentOS¶

create /etc/yum.repos.d/gauge-nightly.repo with the following content:

[gauge-nightly]
name=gauge-nightly
baseurl=http://dl.bintray.com/gauge/gauge-rpm/gauge-nightly
gpgcheck=0
enabled=1

You can use this command to do it in one step:

echo -e "[gauge-nightly]\nname=gauge-nightly\nbaseurl=http://dl.bintray.com/gauge/gauge-rpm/gauge-nightly\ngpgcheck=0\nenabled=1" | sudo tee /etc/yum.repos.d/gauge-nightly.repo

Install on Fedora:

sudo dnf install gauge

Install on CentOS/RHEL:

sudo yum install gauge

Having trouble with installation? Head over to our Installation FAQ’s.

Plugins¶

Language runner¶

C#¶

gauge install csharp

Java¶

gauge install java

Javascript¶

gauge install js

Python¶

gauge install python

Ruby¶

gauge install ruby

One can use IDEs to create the projects and run specifications, for this example, we are using the command line options.

Reporting plugin¶

HTML Reports¶

gauge install html-report

XML Reports¶

gauge install xml-report

Verify your installation¶

You can check the version of your plugin and Gauge core by executing the following command.

gauge version

If this enlists a version then you’re intallation and initialisation is has been successful. Your output will look like this:

Gauge version: <version number>

Plugins
-------
plugin(<version number>)

You can read more about plugins here.

If you have Gauge and your language runner installed, then see how you can create a Gauge project.

Uninstallation¶

Warning

The Gauge folder(~/.gauge in Mac/Linux and in %APPDATA%Gauge in windows) has to be removed manually.

This folder contains Gauge config, logs and plugins.
If you plan to remove the installed plugins explicitly, follow the steps in Plugins first.

Gauge¶

To uninstall Gauge, run the following commands:

Windows¶

Uninstallation using choco

choco uninstall gauge

OS X¶

Uninstallation using brew

brew uninstall gauge

Debian, Ubuntu¶

Uninstallation using apt-get

sudo apt-get remove gauge

CentOS/RHEL¶

Uninstallation using yum

yum remove gauge

Fedora¶

dnf remove gauge

If Gauge is installed in custom location, remove corresponding files/directory.

More on Gauge install location can be found here.

Alternate Methods¶

Plugins¶

Plugins can be uninstalled using the uninstall subcommand. The command is

gauge uninstall <plugin-id>

Example:

gauge uninstall java

To uninstall a specific version of the plugin, use the --version flag.

Example:

gauge uninstall java --version 0.3.2