Plugins are an easy way to extend the features of gauge. There are various types of plugins that gauge currently supports.
Language plugins, also known as Language Runners, enable the users to write the implementation of specs in a language of their choice. For a list of available language runners, see how to install language runners. Allows you to write your tests in
Reporting plugins generate execution reports in various formats.
Documentation plugins generate readable and easy to navigate documentation from the specs.
Plugins are installed using the flag
install, this checks our plugin
repository and downloads them.
gauge --install <plugin_name>
gauge --install html-report
To install a specific version of a plugin use the
gauge --install html-report --plugin-version 2.1.0
If plugin should be installed from a zip file instead of downloading
from plugin repository, use the
gauge --install html-report --file ZIP_FILE_PATH
Download the latest version of plugin from the
Releases section of
the respective repository. See plugin list to
find the repositories.
Adding plugins to a project¶
Once plugins are installed, they can be added to the project by using
add-plugin flag i.e.
gauge --add-plugin <plugin_name>
gauge --add-plugin xml-report
To update a plugin to the latest version of it, use the
flag. This downloads the latest plugin from our plugin repository.
gauge --update <plugin_name>
gauge --update java
To update a plugin to a specific version, use the
gauge --update java --plugin-version 0.3.2
You can also update all the installed plugins by running
Read the Installation troubleshooting for more.
Gauge has a bunch of plugins so that users can easily author specs on IDE. For more details, check IDE Support.