Edit

Installing Gauge

This getting started guide takes you through the core features of Gauge. By the end of this guide, you’ll be able to install Gauge and learn how to create your first Gauge test automation project.

If you are new to Gauge, check out the Overview section in the docs for a quick introduction to the most important features of the tool.

Choose your Setup to Install Gauge

Select your setup to see the instructions for installing gauge.

1. Select your OS
2. Select a Language
3. Select an IDE/Editor

Installation Instructions

Setup
macOS
JavaScript
Visual Studio Code

Step 1: Installing Gauge on macOS

This section gives specific instructions on setting up Gauge in a macOS environment.

Install Using HomeBrew

System Requirements

  • macOS >= Mac OS X v10.6
  • Homebrew
  • Commandline tool
  • Terminal

Note

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

1. Install brew if you haven’t already: Go to the brew website, and follow the directions there.

  1. Run the brew command to install Gauge
brew install gauge

if HomeBrew is working properly, you should see something similar to the following:

==> Downloading https://homebrew.bintray.com/bottles/gauge-1.0.6.mojave.bottle.tar.gz
==> Downloading from https://akamai.bintray.com/45/45b496b39ee682a95ca49b36a94e8041e03fca3644e80223c36539f495fee384?__gda__=exp=1568017021~hmac=f6ca3a9
######################################################################## 100.0%
==> Pouring gauge-1.0.6.mojave.bottle.tar.gz
🍺  /usr/local/Cellar/gauge/1.0.6: 3 files, 18.5MB

Alternate Installation Methods

Install using CURL

System Requirements

  • macOS >= Mac OS X v10.6
  • Commandline tool (curl command)
  • Terminal

Install Gauge to /usr/local/bin by running

curl -Ssl https://downloads.gauge.org/stable | sh

Or install Gauge to a [custom path] using

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

Install using ZIP file

System Requirements

  • macOS >= Mac OS X v10.6
  • Commandline tool (unzip command)
  • Terminal
  1. For signed binaries first download the zip installer
    Zip Installer
  2. Run the following command in your Commnad line tool to complete the installation.
unzip -o gauge-GAUGE_LATEST_VERSION_PLACEHOLDER-darwin.x86_64.zip -d /usr/local/bin

Install using NPM installation

System Requirements

To install gauge using NPM you will need the latest node version.

  • If you have Node.js already installed - to get the latest version of npm use the following command:

‘npm install -g npm@latest

You can install Gauge by running the following command in Terminal.

npm install -g @getgauge/cli

Nightly Installation

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

Step 1: Installing Gauge on Windows

This section gives specific instructions on setting up Gauge in a Microsoft Windows environment.

Install using Windows Installer

Download the following installation bundle to get the latest stable release of Gauge.

Windows installer

Once you finished installing Gauge, you can go ahead and install the Gauge Extension for Visual Studio Code Plugin

Note

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

Alternate Installation Methods

Install using Chocolatey Package Manager

System Requirements

Chocolatey Package Manager

For this to work, you will need to install Chocolatey. If you have chocolatey installed then all you need to is to follow the steps below, it will download and install Gauge.

Note

Some of the following instructions mention the “command prompt”. Where this is used, it refers to the Windows cmd.

  • To open your Command Prompt, click your Start Button
  • In Search type, “cmd”
  • Then click on “Command Prompt”
  • Type the following command in your Command Prompt to install Gauge.
choco install gauge

Install using Zip file

System Requirements

  • Powershell
  1. Download the following zip installer.

  2. Extract it to a location and add it to system path using the following command in Powershell.

Expand-Archive -Path gauge-1.0.6-windows.x86_64.zip -DestinationPath custom_path

Install using NPM installation

System Requirements

To install gauge using NPM you will need the latest node version.

  • If you have Node.js already installed - to get the latest version of npm use the following command:

‘npm install -g npm@latest

You can install Gauge by running the following command in Terminal.

npm install -g @getgauge/cli

Nightly Installation

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

Step 1: Installing Gauge on 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 Using Shell Script APT_GET

  1. First, add Gauge’s GPG key with this command:
sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net --recv-keys 023EDB0B
  1. Then add Gauge to the repository list using:
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

Note

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

Alternate Installation Methods

Install using DNF Package Manager

Install Gauge using dfn by running this command

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
sudo dnf install gauge

Install using ZIP file

System Requirements

  • Commandline tool (unzip command)
  • Terminal
  1. Download the zip installer.

  2. Extract to a location and add it to system path using the following command.

unzip -o gauge-1.0.6-linux.x86_64.zip -d /usr/local/bin

Install using NPM installation

System Requirements

To install gauge using NPM you will need the latest node version.

  • If you have Node.js already installed - to get the latest version of npm use the following command:

‘npm install -g npm@latest

You can install Gauge by running the following command in Terminal.

npm install -g @getgauge/cli

Install Using CURL

System Requirements

  • Commandline tool (curl command)
  • Terminal

Install Gauge to /usr/local/bin by running

curl -SsL https://downloads.gauge.org/stable | sh

Or install Gauge to a [custom path] using

curl -SsL https://downloads.gauge.org/stable | sh -s -- --location-[custom 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.

Step 2: Installing Gauge extension for Visual Studio Code

System Requirements

Latest Visual Studio Code

Follow the steps to add the Gauge Visual Studio Code plugin from the IDE

1. Install the following Gauge extension for Visual Studio Code.

Note

If you don’t have Visual Studio Code installed, you can install it by clicking on Get it now link in the browser popup.

2. On the extension page that opens in the IDEs, click the install button
Select template

Other install options

Step 2: Installing Gauge extension for IntelliJ IDEA

System Requirements

Latest IntelliJ IDEA

Follow the steps to add the Gauge IntelliJ IDEA plugin from the IDE

  1. Open the Settings dialog.
  2. In the left-hand pane, select Plugins.
  3. In the top pane, select Marketplace.
  4. Type Gauge in the serach bar and click on Install option.
Select template
  1. Once the installation is complete click on the Restart IDE to restart the IDE.

Other install options

Step 2: Installing Gauge extension for Visual Studio

Follow the steps to add the Gauge Visual Studio plugin from the IDE

  1. Open Visual Studio Extension Manager from Tools -> Extensions and Updates.
  2. In the left-hand pane, select Online and search for gauge on the right-hand pane and click on the Download option.
Search gauge
  1. Once the download is complete close all Visual Studio windows to apply the changes.
Close all VS windows

Now that you’ve installed Gauge, you can go ahead and create a C# testing project using Gauge.

Now that you’ve installed Gauge, you can go ahead and create a Java testing project using Gauge.

Now that you’ve installed Gauge, you can go ahead and create a JavaScript testing project using Gauge.

Now that you’ve installed Gauge, you can go ahead and create a Python testing project using Gauge.

Now that you’ve installed Gauge, you can go ahead and create a Ruby testing project using Gauge.