Command Line Interface

The Command Line Interface

Gwen is designed to do everything on the command line. In this way:

• You have direct control over exactly what you want to do
• It is very simple to use
• Having a GUI is not necessary
  • We do not discourage anyone in the community to build one if they have time (and we can try to help if you do)
• Lastly, we believe that..
  • If you can use a tool on the command line, then you can use it consistently everywhere
  • The same commands that run on your local machine will run the same way on a server
  • The interface is the same on Windows and Unix platforms
  • Convenience wrapper scripts can easily be created if desired

Launch Options

The easiest way to see what launch options are available is to open a command prompt and launch Gwen with the --help option.

• If you do not have the bin directory of your installed Gwen engine on your system path
  • Open a command prompt and navigate to the bin directory
• If you do
• Then you can launch Gwen from any directory

When you're ready, launch the following command:

gwen --help

The following output will be displayed:

Usage: install-dir/bin/gwen.sh|gwen.bat [options] [<features>]

  [options]
  --version
        Prints the implementation version
  --help
        Prints this usage text
  -b | --batch
        Batch/server mode
  -| | --parallel
        Parallel batch execution mode)
  -p <properties files> | --properties <properties files>
        Comma separated list of properties file paths
  -r <report directory> | --report <report directory>
        Evaluation report output directory
  -f <formats> | --formats <formats>
        Comma separated list of report formats to produce
         - Supported formats include: html,junit (default is html)
  -t <tags> | --tags <tags>
        Comma separated list of @include or ~@exclude tags
  -n | --dry-run
        Do not evaluate steps on engine (validate for correctness only)
  -i <input data file> | --input-data <input data file>
        Input data (CSV file with column headers)
  -m <meta files> | --meta <meta files>
        Comma separated list of meta file paths

  [<features>]
       Space separated list of feature files and/or directory paths

If you get stuck, there are several launch examples on our FAQ.