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. OS
2. Language
3. IDE/Editor

Installation Instructions

Setup
macOS
JavaScript
VS Code

Step 1: Installing Gauge on macOS

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

Install Using HomeBrew (Preffered)

System Requirements

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

Install brew, and run the following command

brew install gauge

To check the gauge is installed properly, run the following command, this will show you the version of successfully installed gauge.

gauge --version

You can also use any of these other ways to install Gauge

Install using NPM installation

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

npm install -g @getgauge/cli

Install using CURL

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

Download the Zip Installer and run the following command to complete the installation.

unzip -o gauge-GAUGE_LATEST_VERSION_PLACEHOLDER-darwin.x86_64.zip -d /usr/local/bin

Step 1: Installing Gauge on Windows

This section gives specific instructions on setting up Gauge in a Microsoft Windows environment. You can choose any ONE of the following.

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 VS Code Plugin

Install using Chocolatey Package Manager

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

  • Open your Windows Command Prompt as administrator
  • 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

Download the following Zip Installer extract it to a location and add it to system path using the following command in Powershell.

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

Install using NPM installation

To install gauge using NPM you will need the latest node version. You can install Gauge by running the following command in Terminal.

npm install -g @getgauge/cli

Step 1: Installing Gauge on Linux

You can use one of the following ways to install Gauge on your linux distribution

Install Using CURL

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]

Install using NPM

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

npm install -g @getgauge/cli

Install using ZIP file

Download the Zip Installer Extract to a location and add it to system path using the following command.

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

Step 2: Installing Gauge extension for VS Code

System Requirements

Latest VS Code

Follow the steps to add the Gauge VS Code plugin from the IDE

1. Install the following Gauge extension for VS Code.

Note

If you don’t have VS 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

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.