Skip to end of metadata
Go to start of metadata

Using Allure command line tool you can generate the report from existing Allure results.

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:

Install Allure CLI for debian

Supported distributions are: Trusty and Precise. After installation you will have allure command available. Read more about Allure Debian Package.

Mac OS

You can install Allure CLI via Homebrew.

Install Allure CLI for Mac

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

Windows and other Unix

Configuration

To configure the Allure report you should create allure.properties file

An example of allure.properties

and simply generate the report. By default command line tool looking for config in directory you run the command.  You can use ALLURE_CONFIG environment variable to specify the path to configuration.

Usage

There is few commands available.

Generate the report

To generate the report from existing Allure results you can use the following command:

Generate the report using Allure CLI

The report will be generated to allure-report folder. You can change the destination folder using -o flag:  

Generate the report using Allure CLI

For more information use the allure help generate command.

Open the report

When the report is generated you can open it in your default system browser. Simply run

Open the report using Allure CLI

Clean the report 

If you want to remove the generated report data use allure report clean command.

Note

By default the report commands will looking for the report in allure-results folder. If you are want to use the report from different location you can use -o option.

  • No labels