Beta

Get Started

Choose your OS & download

OSX

There are multiple ways to get started with Gauge on a Mac. Here we show you a simple 4 step process to get you running with Gauge on a Mac. You can read our detailed documentation for other methods of installation.

Install Gauge

Download the installer below based on your system configuration and just click your way through to install Gauge. You will need to use this method if your setup or organization does not allow brew.

pkg ( latest stable version: 0.8.1 )
32 bit SHA-1: 6e58a84478813a6fbed34a2cf3bd887ff72bc043
64 bit SHA-1: 6d018add23c3566744afcee0c41294b0ae3d8a68

We would recommend using brew for a very simple straightforward installation using this command.

~ $ brew update ~ $ brew install gauge

Install core plugins

Gauge has a rich plugin repository. Language runners, IDEs, and reports are all plugins. Since Gauge is a first class command line tool, you only *need* one plugin to get your Gauge tests running. That is your language runner plugin.

~ $ gauge --install java

Read more about how to install other language runners and plugins here.

Test your installation

Check that all plugins are installed and are at the latest version by running this command.

~ $ gauge -v
Gauge version: 0.5.0

Plugins
-------
java(0.4.1)

See Gauge working

Initialize a new Gauge project in the language of your choice. You can read more about initialization here. This creates a template with a sample test specification. The example below shows how to execute test specifications in Java, but the same applies to all supported languages.

~ $ gauge --init java

Now run the sample specification to see how Gauge works.

~ $ gauge specs
Specifications:	1 executed	1 passed	0 failed	0 skipped
Scenarios:    	2 executed	2 passed	0 failed	0 skipped

Total time taken: 80ms

You're all set. Start testing!

Windows

There are two ways to install Gauge on Windows. Below we show the process using the .exe. The other option is to use Chocolatey. Read more here about how to install Gauge using Chocolatey.

Install Gauge

Download the exe based on your system configuration and run it. Click your way through till you're asked to select your language. The next section explains what that means.
exe (latest stable version: 0.8.1 )
32 bit SHA-1: d057a7d0bb121d87aeb470358617acdd3a459e1c
64 bit SHA-1: 49704df09ff5ab4fdc78f7bcab0214d7e964a568

Install core plugins

Gauge has a rich plugin repository. Language runners, IDEs, and reports are all plugins. Since Gauge is a first class command line tool, you only *need* one plugin to get your Gauge tests running. That is your language runner plugin.

The Windows installer allows you to select the language plugin(s) as part of the the installation process. Check the box(es) you want to install. You can select more than one language plugin to install.

Select language

Follow the remaining installation steps.

Test your installation

Check that all plugins are installed and are at the latest version by running this command.

> gauge -v
Gauge version: 0.5.0

Plugins
-------
csharp(0.7.2)

See Gauge working

Initialize a new Gauge project in the language of your choice. You can read more about initialization here. This creates a template with a sample test specification. The example below shows how to execute test specifications in C#, but the same applies to all supported languages.

> gauge --init csharp

Now run the sample specification to see how Gauge works.

> gauge specs
Specifications:	1 executed	1 passed	0 failed	0 skipped
Scenarios:    	2 executed	2 passed	0 failed	0 skipped

Total time taken: 80ms

You're all set. Start testing!

Linux

Gauge can be installed on any flavour of Linux using the shell script. The following steps will guide you to a quick install on a linux box.

Install Gauge

Install Gauge by downloading the .zip below. Choose the archive file based on your system configuration.

zip (latest stable version: 0.8.1 )
32 bit SHA-1: 0ce39af2d389c76c5324ef6fccccc9a37d1d4c48
64 bit SHA-1: 78959c2027208308a23ef7db71b2e9181c1e0e11

Then execute the following command:

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

Install core plugins

Gauge has a rich plugin repository. Language runners, IDEs, and reports are all plugins. Since Gauge is a first class command line tool, you only *need* one plugin to get your Gauge tests running. That is your language runner plugin.

~ $ gauge --install java

You can read more about how to install other language runners and plugins here.

Test your installation

Check that all plugins are installed and are at the latest version by running this command.

~ $ gauge -v
Gauge version: 0.5.0

Plugins
-------
java(0.4.1)

See Gauge working

Initialize a new Gauge project in the language of your choice. You can read more about initialization here. This creates a template with a sample test specification. The example below shows how to execute test specifications in Java, but the same applies to all supported languages.
~ $ gauge --init java

Now run the sample specification to see how Gauge works.

~ $ gauge specs
Specifications:	1 executed	1 passed	0 failed	0 skipped
Scenarios:    	2 executed	2 passed	0 failed	0 skipped

Total time taken: 80ms

You're all set. Start testing!