Plugins¶
Plugins are an easy way to extend the features of gauge. There are various types of plugins that gauge currently supports.
Language/Reporting Plugins¶
Language Plugins
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
Reporting plugins generate execution reports in various formats.
Documentation Plugins
Documentation plugins generate readable and easy to navigate documentation from the specs.
Installation¶
Plugins are installed using the subcommand install
, this checks our plugin
repository and downloads them. gauge install <plugin_name>
Example:
gauge install html-report
To install a specific version of a plugin use the --version
flag.
gauge install html-report --version 2.1.0
To add a plugin to project, issue subcommand install
inside the project, this installs
the plugin and add it to project. If plugin is already installed it just add it to the project i.e.
gauge install <plugin_name>
Example:
gauge install xml-report
Offline Installation¶
If plugin should be installed from a zip file instead of downloading
from plugin repository, use the --file
or -f
flag.
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.
Updating plugins¶
To update a plugin to the latest version of it, use the update
subcommand. This downloads the latest plugin from our plugin repository.
gauge update <plugin_name>
Example:
gauge update java
To update a plugin to a specific version, use the --version
flag.
gauge update java --version 0.3.2
You can also update all the installed plugins by running
gauge update --all
Read the Installation troubleshooting for more.
IDE plugins¶
Gauge has a bunch of plugins so that users can easily author specs on IDE. For more details, check IDE Support.
- Integration with Visual Studio Code
- Integration with IntelliJ IDEA
- Integration with Visual Studio