Setup
macOS
JavaScript
VS Code
Modify
To install a plugin and add the plugin to a Gauge project, use the following command from within the project directory:
gauge install java
gauge install js
gauge install python
gauge install ruby
gauge install csharp
If the plugin is already installed, Gauge just adds the plugin to the project.
Note
The html-report and screenshot plugins are installed automatically on the first run.
To install a specific version of a plugin, use the --version flag on your command line:
gauge install java --version <plugin_version>
gauge install js --version <plugin_version>
gauge install python --version <plugin_version>
gauge install ruby --version <plugin_version>
gauge install csharp --version <plugin_version>
You can also install a plugin from a zip file instead of downloading from the plugin repository by using the following command:
gauge install java --file ZIP_FILE_PATH
gauge install js --file ZIP_FILE_PATH
gauge install python --file ZIP_FILE_PATH
gauge install ruby --file ZIP_FILE_PATH
gauge install csharp --file ZIP_FILE_PATH
You can download the latest version of a plugin from the Releases section of the plugin’s GitHub repository. See the plugin list to find the Gauge repositories.
By default, the plugins are stored at %APPDATA%\gauge\plugins in Windows.
By default the plugins are stored at ~/.gauge/plugins in macOS X and Linux systems.
By default the plugins are stored at ~/.gauge/plugins in Linux systems.
You can also install the plugins at different locations.
To install plugins at a different location, set GAUGE_HOME environment variable to the custom location.
Run the plugin install command. The plugin is installed at the GAUGE_HOME custom location.
For troubleshooting information during plugin installation, see Troubleshooting plugin installation.
You can update a plugin by using the gauge update command. This command downloads the latest compatible plugin from the Gauge plugin repository .
gauge update java
gauge update js
gauge update python
gauge update ruby
gauge update csharp
Note
Every Gauge plugin when published has metadata indicating the min and max version of Gauge that the plugin is compatible with. The gauge update command is used when installing plugins on a system running a particular gauge version.
To update a plugin to a specific version, use the --version flag as follows:
gauge update java --version <plugin_version>
gauge update js --version <plugin_version>
gauge update python --version <plugin_version>
gauge update ruby --version <plugin_version>
gauge update csharp --version <plugin_version>
To update all the installed plugins, use the following command:
gauge update --all
Uninstall the plugins by using the following command:
Example:
gauge uninstall java
gauge uninstall js
gauge uninstall python
gauge uninstall ruby
gauge uninstall csharp
To uninstall a specific version of the plugin, use the
--version flag.
Example:
gauge uninstall java --version <plugin_version>
gauge uninstall js --version <plugin_version>
gauge uninstall python --version <plugin_version>
gauge uninstall ruby --version <plugin_version>
gauge uninstall csharp --version <plugin_version>
If plugin installation fails due to a network connection issue, you can manually download the plugin distributable zip and install the plugin by using the following command:
gauge install java -f path_to_zip_file
gauge install js -f path_to_zip_file
gauge install python -f path_to_zip_file
gauge install ruby -f path_to_zip_file
gauge install csharp -f path_to_zip_file
You can find the plugin zip files in the Releases section of the plugin GitHub repositories. See the plugin list for plugin repository details.
Plugins are installed in the .gauge/plugins directory in the user’s home directory. You can check this directory to manually install or uninstall plugins and also to verify the installed plugins.
The plugin installation directory for Windows operating system is %APPDATA%\.gauge\plugins
The plugin installation directory for macOS X operating system is ~/.gauge/plugins
The plugin installation directory for Linux operating system is ~/.gauge/plugins
The different types of plugins currently supported by Gauge are as follows:
Language plugins or language runners enable the users to write the implementation of specifications in a language of the user’s choice. When you intitialize a Gauge project, the language plugin is installed by default.
To run Gauge projects in the .Net framework, use the following command:
gauge install csharp
For more information about running and configuring CSharp with Gauge, read the Gauge GitHub repository
To run Gauge projects in the .Net Core framework, use the following command:
gauge install dotnet
For more information about running and configuring .Net with Gauge, read the Gauge GitHub repository
To run Gauge projects with Java, use the following command:
gauge install java
For more information about running and configuring Java with Gauge, read the Gauge GitHub repository
To run Gauge projects with JavaScript, use the following command:
gauge install js
For more information about running and configuring JavaScript with Gauge, read the Gauge GitHub repository
For more information about running and configuring Python with Gauge,
gauge install python
For more information about running and configuring Python with Gauge, read the Gauge GitHub repository
To run Gauge projects with Ruby, use the following command:
gauge install ruby
For more information about running and configuring Ruby with Gauge, read the Gauge GitHub repository
Reporting plugins generate execution reports in various formats. Depending on the format of the report you need, you can install the appropriate plugin.
gauge install html-report
For more information about HTML report generation plugin for Gauge, see Gauge GitHub for HTML report generation .
gauge install xml-report
For more information about XML-report generation plugin for Gauge, see Gauge GitHub for XML report generation .
gauge install flash
For more information about Flash plugin for Gauge, see Gauge GitHub for Flash .
Gauge has plugins for popular IDEs that improve the experience of authoring test specifications. We recommend that you use the VSCode plugin. However, Gauge can be used without a plugin on any editor of your choice.
Gauge projects can be created and run in VS Code by using the Gauge extension for VS Code. This plugin currently supports Gauge with Java, JavaScript, Ruby, Python, C# (.Net Core), and TypeScript.
The spectacle plugin generates a readable HTML format of the specifications:
gauge install spectacleFor more information about gauge spectacle, see Gauge GitHub for Spectacle
Gauge also supports the dependency management workflow with custom plugins for Maven and Gradle.