Allure Command Line Tool

Allure CLI allows you to generate Allure report from existing XML files 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.

Table of Contents

• Installation
  • Debian
  • Mac
  • Windows and other Unix
• Configuration
• Usage
  • Generating Report
  • Selecting Report Version
  • Getting Help

Installation

Allure CLI is a Java application so it's available for all platforms. You have to manually install Java 1.7+ before using Allure CLI.

Debian

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 and Precise. After installation you will have allure command available. Read more about Allure Debian Package

Mac

You can install Allure CLI via Homebrew

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

After installation you will have allure command available. Read more about Allure Homebrew Formula

Windows and other Unix

• Download latest version as ZIP archive
• Unpack the archive to allure-cli directory
• Navigate to bin directory
• Use allure.bat for Windows and allure for other Unix platforms

Configuration

Defaults:

• Report Path: allure-report
• Report Version: 1.3.9

Usage

Generating report

To generate report simply run the following command:

$ allure generate path/to/directory/with/xml/files

or

$ allure report generate path/to/directory/with/xml/files

By default report is generated to directory named allure-report. When done simply open index.html page from the output directory or type:

$ allure report open

To clean report direcotory use the following command:

$ allure report clean

In order to change output directory type:

$ allure generate path/to/directory/with/xml/files -o path/to/output/directory

Selecting Report Version

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

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

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

Getting help

To show help type:

$ allure help

To show help about specific command type:

$ allure help generate

Contact us

Mailing list: [email protected]