Installation

For recommended installation, refer Getting Started. This page lists alternate methods of installing Gauge and plugins.

Note

Gauge automatically sends telemetry data to help us improve the product. If you would prefer not to have this data sent you can choose to opt out

Gauge

Windows

Offline Installation

Download the Gauge archive from here. Extract it to a location and add it to system path.

Nightly installation

Nightly releases are latest development snapshots of Gauge. They have the latest features being developed, but are unstable.

Download the Gauge archive from here. Extract it to a location and add it to system path.

macOS

Offline Installation

Download the Gauge archive from here. Extract it to a location and add it to system path.

Nightly installation

Nightly releases are latest development snapshots of Gauge. They have the latest features being developed, but are unstable.

Download the Gauge archive from here. Extract it to a location and add it to system path.

Debian/APT

Offline Installation

Download the Gauge archive from here. Extract it to a location and add it to system path.

Nightly Installation

Nightly releases are latest development snapshots of Gauge. They have the latest features being developed, but are unstable.

Add Gauge’s GPG key:

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

Add to repository list:

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

Install

sudo apt-get update
sudo apt-get install gauge

YUM/DNF

Offline Installation

Download the Gauge archive from here. Extract it to a location and add it to system path.

Nightly Installation

Nightly releases are latest development snapshots of Gauge. They have the latest features being developed, but are unstable.

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

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

sudo yum install gauge

or

sudo dnf install gauge

Zip

Nightly Installation

Download the Gauge archive from here. Extract it to a location and add it to system path.

Curl

To install at custom location

curl -SsL https://downloads.gauge.org/stable | sh -s -- --location=[custom path]

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

Plugins

Plugins are an easy way to extend the features of Gauge. There are various types of plugins that Gauge currently supports.

Language Runner

Language plugins enable the users to write the implementation of specs in a language of their choice.

CSharp

to use .Net Framework as runtime

gauge install csharp

Read more here

to use .Net Core as runtime

gauge install dotnet

Read more here

Java

gauge install java

Read more here

JavaScript

gauge install js

Read more here

Python

gauge install python

Read more here

Ruby

gauge install ruby

Read more here

Reporting Plugins

Reporting plugins generate execution reports in various formats.

Html-Report

gauge install html-report

Read more here

Xml-Report

gauge install xml-report

Read more here

Documentation Plugins

Documentation plugins generate readable and easy to navigate documentation from the specs.

Spectacle

gauge install spectacle

Read more here

Install a specific plugin version

To install a specific version of a plugin use the --version flag.

gauge install html-report --version 2.1.0

Add plugin to a project

Run gauge install <plugin_name> from within the project directory, to install the plugin and add it to project. If plugin is already installed it just add it to the project.

Offline Installation of Plugin

Any Gauge plugin can be installed from a zip file instead of downloading from plugin repository by using the --file or -f flag.

gauge install html-report --file ZIP_FILE_PATH

Download the latest version of plugin from the Releases section of the respective repository. See plugin list to find the repositories.

Updating plugins

Run gauge update <plugin_name> to update the plugin. This downloads the latest compatible plugin from our plugin repository.

Note

Every Gauge plugin when published, has metadata indicating the min and max version of Gauge that it is compatible with. This is used when installing plugin on a system running a particular gauge version.

Example:

gauge update java

To update a plugin to a specific version, use the --version flag.

gauge update java --version 0.3.2

You can also update all the installed plugins by running

gauge update --all

Read the Installation troubleshooting for more.

Note

The html-report and screenshot plugins are installed automatically on the first run.

Discovering Project templates

Gauge hosts a list of project templates, to help setup specific type of projects. Run gauge init --templates to see the list of available templates.

Build Tools

Uninstall Gauge

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.
  • Plugins should be removed before uninstalling gauge. Follow the steps in Uninstall Plugins.

Windows

Uninstallation using chocolatey

choco uninstall gauge

macOS

Uninstallation using HomeBrew

brew uninstall gauge

Debian/APT

Uninstallation using apt-get

sudo apt-get remove gauge

YUM/DNF

Uninstallation using yum

yum remove gauge

or

dnf remove gauge

Zip

Remove the gauge binary from installed location. The entry from PATH that was added during installation, can also be removed.

Curl

Remove the gauge binary from installed location. The entry from PATH that was added during installation, can also be removed.

Note

If Gauge is installed in custom location, remove corresponding files/directory. More on Gauge install location can be found here.

Uninstall 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

Troubleshooting

Logs

  • Gauge logs are created under the logs directory in the project.
  • Three log files are created
    • gauge.log - logs for test execution
    • api.log - logs for gauge core api exposed for plugins
    • lsp.log - logs for gauge when launched in LSP mode.
  • To customize logs directory set the logs_directory property in the env/default/default.properties file to a custom logs directory path.
logs_directory = my_logs_dir
  • For non-project specific actions like plugin installation log files are created in the following location.
Windows - %APPDATA%\gauge\logs
MacOS*  - <user_home>/.gauge/logs
Linux   - <user_home>/.gauge/logs

Gauge Installation

Windows

  • The default installation location is %ProgramFiles%\gauge.
  • gauge_install_location\bin should be in PATH to run from command line.
  • Gauge plugins are installed at %APPDATA%\gauge\plugins directory.
  • APPDATA directory is usually located at C:\Users\USER_NAME\AppData\Roaming.

Mac OS X

  • The default installation location is /usr/local/.
  • usr/local/bin/ or custom_install_location/bin should be in PATH.
  • Run brew update before installing the latest version of gauge.
  • If installation is failing Upgrade homebrew
  • Gauge plugins are installed under ~/.gauge/plugins directory.

Linux

  • The default installation location is /usr/local/.
  • usr/local/bin/ or custom_install_location/bin should be in PATH.
  • Gauge plugins are installed under ~/.gauge/plugins directory.

Plugin installation

  • If plugin installation fails due to a network connection issue, you can manually download the plugin distributable zip and install it using the -f flag.
gauge install plugin_name -f path_to_zip_file

Example:

gauge install html-report -f html-report-1.0.3-darwin.x86.zip
  • Find the plugin zip files under Releases section of the plugin github repositories. See the gauge plugin list for plugin repositories details.

Plugins directory

Plugins are installed in the .gauge/plugins directory in user’s home. You can check this directory to manually install / uninstall plugins as well as to verify the installed plugins.

The plugin installation directory for various operating systems are listed below.

  • Windows: %APPDATA%\.gauge\plugins
  • Mac OS X: ~/.gauge/plugins
  • Linux: ~/.gauge/plugins

Custom Plugin Install location

By default the plugins are stored at %APPDATA%\gauge\plugins for windows and ~/.gauge/plugins in mac and linux.

To install plugins at different location, set GAUGE_HOME environment variable to the custom location. After setting the GAUGE_HOME env, run the install command. The plugin will get installed at the GAUGE_HOME custom location.