Skip to main content

Get Started

tip

Read the introduction to learn more about Gwen before getting started.

Use this option to set up Gwen as a standalone installation on your machine.

System requirements

  • Linux, Mac or Windows OS
  • Chrome, Firefox, Safari, Edge or IE web browser
  • Java SE 8+, install Java

1. Download and install Gwen#

  • Browse the releases and download the binary gwen-web-<version>.zip package of the version you want to install and use
  • Extract the downloaded ZIP into a desired directory

This will give you the following file system setup:

 /gwen-web-<version>         # Your installation root โ”œโ”€โ”€ gwen                    # Linux launch script โ”œโ”€โ”€ gwen.bat                # Windows launch script โ”œโ”€โ”€ /bin                    # Gwen scripts โ”œโ”€โ”€ /lib                    # Gwen binaries โ””โ”€โ”€ /samples                # Sample features and meta

2. Add Gwen to your system path#

Add the absolute location of your gwen-web-<version>/bin directory to your system PATH to make Gwen available in any directory on your machine.

set PATH variable

Run the following command to set the PATH in your current session temporarily or consult your OS manual to make it permanent:

export PATH=$PATH:/absolute/path/to/gwen-web-<version>/bin

Replace:

  • /absolute/path/to with the absolute path to the location where you extracted the ZIP in step 1
  • <version> with the Gwen version you installed
No automatic updates

You will need to repeat steps 1 and 2 to udpate.

3. Set your default browser#

Gwen is configured to use the Chrome browser by default. To change it, create a new gwen.properties file in your user directory and set the following setting to your preferred default:

Amend setting

File: gwen.properties

# default browser to usegwen.web.browser = firefox

Where:

  • Browser options include: chrome, firefox, safari, edge, or ie

This example sets Firefox as the default browser.

4. Execute the samples#

Run the following command in your installation directory to execute the sample feature specs.

Launch Gwen
gwen -b -r output/reports samples

Where:

  • The -b switch instructs Gwen to exit immediately after executing the samples. Omitting it will open the REPL Console instead of exiting.
  • The -r option sets the report output directory to output/reports
  • samples is the directory containing the meta and feature samples to execute

CLI usage

An evaluation report will be generated at output/reports/index.html in your directory.

5. Create and execute your own meta and features#

Create a new features directory in a preferred location on your machine and start adding your own feature and meta files there. Run the following command in the parent directory to execute them:

Launch Gwen
gwen -b -r output/reports features

Where:

  • The -b switch instructs Gwen to exit immediately after executing your features. Omitting it will open the REPL Console instead of exiting.
  • The -r option sets the report output directory to output/reports
  • features is the directory containing your meta and feature files to execute

CLI usage