How to Generate a Report

Run Tests and Generate Reports

Running tests and generating a report with Allure 3 is straightforward. Using the run command, you can execute your test suite and automatically generate a report:

allure run -- <test_command>

For example, if you're using npm as your test runner, the command would be:

allure run -- npm test

To successfully generate a report, ensure that your test setup outputs results into an allure-results directory, which is automatically detected by Allure 3. This directory can be placed at any nested level within your project (e.g., out/tests/allure-results), provided it retains the correct name.

After the tests complete, the report is generated automatically. Existing results from previous runs are ignored, as Allure 3 focuses solely on new data to ensure accurate and up-to-date reporting.

Generate Reports Manually from Existing Results

If you already have test results and wish to generate a report manually, use the generate command:

allure generate <resultsDir>

This generates a standard Allure 3 report. You can customize output settings, such as the destination directory, through the configuration file.

Generate Reports with the Allure Awesome Plugin

Allure 3 also features an advanced report generator plugin - Allure Awesome. It supports additional configuration options, such as generating the report as a single HTML file, setting the theme, custom branding and language of the generated report, and taking known issues into account.

To explore all currently available Allure Awesome features, run:

allure awesome --help

To manually generate a customized Allure Awesome report, use the awesome command:

allure awesome <resultsDir> [options]