Intellij support for Gauge project.
The Gauge team will stop addding new features to the IntelliJ Gauge plugin, only bug fixes will be done henceforth. The Gauge team will officially end support for IntelliJ Gauge plugin in October 2020.
If you wish to take up owership of this plugin, please contact us. We would be happy to transfer the plugin ownwership.
> git clone [email protected]:getgauge/Intellij-Plugin.git > cd Intellij-Plugin > ./gradlew buildPlugin
The plugin zip will be available at
build/distributions. Install the zip file from IntelliJ IDEA
Plugin can be installed by downloading from Jetbrains plugin repository.
Steps to install Gauge Intellij IDEA plugin from IDE:
Open the Settings dialog (e.g. ⌘ Comma).
In the left-hand pane, select Plugins.
On the Plugins page that opens in the right-hand part of the dialog, click the Install JetBrains plugin or the Browse repositories button.
In the dialog that opens, search for Gauge. Right-click on Gauge and select Download and Install.
Confirm your intention to download and install the selected plugin.
Click OK in the Settings dialog and restart IntelliJ IDEA for the changes to take effect.
Note: The plugin you have installed is automatically enabled. When necessary, you can disable it as described in Enabling and Disabling plugins.
To install plugin by downloading it manually or to update plugin, follow the steps here.
Create a new Gauge project and start writing your tests.
Explore all the features of Gauge Intellij IDEA plugin now!
gauge-java is not installed, it will download it for the
Create from Archetype
com.thoughtworks.gauge.maven archetype is not added select
maven add archetype
artifactIdfor your project.
Project Nameand finish
close and re-open the projectto enable auto-complete features.
auto-importfor the project. Under
File > Settings > Maven > Importing, mark the checkbox
Import Maven projects automatically.
See gauge-maven-plugin for more details on using the gauge maven plugin.
Specifications, Scenarios, Steps and Tags are highlighted. Steps with missing implementation are also highlighted.
Steps present in the current project can be listed by invoking the auto
completion pop up
ctrl+space after the '*'.
right Click ->
Go to ->
A specification file can be formatted easily using the keyboard
Spec Format in the action menu
This formats the specification including indentation of tables and steps.
right click -> Run spec.
right click -> Run specifications
A single scenario can be executed by doing a right click on the scenario
which should be executed and choosing the scenario.
right click -> run -> Scenario Name
.. note:: If the right click is done in context other than that of scenario, by default, first scenario will be executed.
To run multiple specifications in parallel
specsdirectory and select
In Paralleloptions. This will distribute specs execution based on number of cores the machine has.
Number of parallel execution streams.
Select parallel nodes based on current systems performance. For example on a 2 core machine select upto 4 parallel streams. A very large number may affect performance.
ok. Now you can run this new configuration for parallel execution of specs.
Debugging can be performed the same way spec execution works.
You can edit the run configuration to make changes to:
- The scenario or spec file to be executed - Choose table-rows to be executed - The environment to run against - Add a tag filter to the execution - Choose the number of parallel streams - Add program arguments (Example: --log-level)
To execute multiple specs/scenarios add
|| seperated list of spec/scenarios in
Specification to execute section
The delimiter for multiple spec files in run config has been changed from comma (
,) to double bar (
||). Until v0.1.0 of IntelliJ plugin, the delimiter is
,. Any higher version will have delimiter
right click -> Refactor -> Renameon a step to rephrase it.
< >in the rephrase dialog. They can be reordered,removed or new parameters can be added.
right click -> Find Usageson step/concept to see the usages.
In the editor, select the steps to be transformed into a concept.
On the main menu or on the context menu of the selection, choose
Refactor | Extract to Concept or press
In the Extract Concept dialog box that opens
The selected steps will be replaced with the specified concept name.
The intellij idea gauge plugin comes with more features to simplify writing specifications.
For example, to create a table with 4 columns type
Then fill the column names in the template.
Then fill the specification name in the template.
Then fill the scenario name in the template.
This is a spec file in markdown.
alt + F2 or right click and select
open in Browser option. It gives option to choose a browser.
On choosig a browser, it opens a browser window with HTML equivalent preview of spec file.
Since specs are written in markdown, they can be converted to HTML using any markdown to HTML convertors.
Copyright (c) ThoughtWorks, Inc.