humlix

Humlix

Generate tests for your organization's Web APIs with Humlix.

CLI for Humlix

Humlix CLI is a command-line test suite runner for Humlix. It lets you generate tests from an OpenAPI specification or a Humlix test suite right from the command-line. It integrates easily with your continuous integration servers.

Table of contents

1. Getting Started
2. Usage
   1. Using Humlix CLI
   2. Using JUnit reporter with Humlix
3. Command-Line Options
   1. humlix options
   2. humlix run
4. JUnit reports
   1. Configuring JUnit reports
5. Support
6. License

Getting started

To run Humlix, ensure that you have a Java runtime environment installed.

Installation

The easiest way to install Humlix is by using NPM.

$ npm install -g humlix

That command will install Humlix globally on your system, allowing you to run it from anywhere. Remove the -g flag if you want to install it locally.

back to top

Usage

Using Humlix CLI

The humlix -r command allows you to run a specific test suite. You can easily export your Humlix test suite from the Humlix application and run it using Humlix CLI. Or you can use an OpenAPI specification.

$ humlix -r suites/my-openapi-specification.yaml

For the complete list of options, refer to the Command-Line Options section below.

Create JUnit reports with Humlix

A JUnit report provides information about the current test suite run in a format that is easy to analyze. Configure Humlix to create JUnit reports using the -o or --output options.

Humlix CLI will default print the results to the console.

$ humlix -r suites/my-openapi-specification.yaml -o my-junit-report.xml

back to top

Command-Line Options

humlix [options]

• -h, --help
  Show command line help, including a list of options and sample use cases.

humlix -r <test-suite-file> [options]

• -e <file-name>, --environment <file-name>
  Specify an environment file path. Environments provide a set of variables for a test suite. Read More

• -g, --generate
  Specify if Humlix will generate tests. By default, Humlix will generate 200 tests unless you specify a count using the -c parameter.

• -m <mail>, --mail <mail>
  Specify the mail address that corresponds with the license key. Use a .env file and set mail as HUMLIX_MAIL='your email'

• -l <license-key>, --license <license-key>
  Specify the license key. Use a .env file and set license key as HUMLIX_LICENSE='your license key'

JUnit reports

Configuring JUnit reports

• -o <file-name>, --output <file-name>
  Sets the file name for the JUnit XML file that Humlix creates during the test suite run.

back to top

Support

If you are interested in talking to the Humlix team, you can find us on feedback at humlix.com. Feel free to give feedback or request features that you would like to see in Humlix.

License