Allure Command Line Interface

Allure command line tool (Allure CLI) allows you to generate Allure report with no need to install any CI system or sophisticated build tool. To generate report with this tool you only need to have XML files generated by adapter.

Installation

Allure CLI is a Java application so it's available for all platforms.

Debian-based systems

For Debian-based repositories we provide a PPA so the installation is straightforward:

$ sudo apt-add-repository ppa:yandex-qatools/allure-framework
$ sudo apt-get update
$ sudo apt-get install allure-cli

Supported distributions are: trusty, saucy and precise. After installation you will have allure command available.

Mac

You can install CLI via Homebrew:

$ brew tap allure-framework/allure
$ brew install allure-cli

You have to manually install Java 1.7+ before brewing Allure. After installation you will have allure command available.

Other Linux and Windows

You can download a Zip archive with the latest distribution of the CLI from Github: https://github.com/allure-framework/allure-cli-zip/releases To run CLI you need to have Java 1.7+ installed. Simply unpack the archive and use either allure or allure.bat script.

Usage

To generate report simply run the following command:

$ allure generate path/to/directory/with/xml/files # CLI 1.3.x only

By default report is generated to directory named output. When done simply open index.html page from the output directory. In order to change output directory type:

$ allure generate /path/to/directory/with/xml/files --outputPath=/path/to/output/directory # CLI 1.3.x only

When using command line tool version 2.0+ you should omit generate keyword:

$ allure /path/to/directory/with/xml/files --outputPath=/path/to/output/directory # CLI 2.0+

Selecting Report Version

Starting from CLI 2.0 you can specify version of the report to be used using -v flag:

$ allure -v 1.3.9 /path/to/directory/with/xml/files
$ allure -v 1.4.0 /path/to/directory/with/xml/files

This allows you to use the same CLI with less or more outdated adapters. All required files are downloaded from Internet automatically (this fact is important if you try to use CLI in offline environment).