Skip to content
Allure report logoAllure Report
Main Navigation ModulesDocumentationStarter Project

English

Español

English

Español

Appearance

Sidebar Navigation

Allure 3: Getting Started

Install & Upgrade

Install for Node.js

Upgrade Allure

Working With Reports

How to generate a report

How to view a report

Improving readability of your test reports

Improving navigation in your test report

Allure 2: Getting Started

Install & Upgrade

Install for Windows

Install for macOS

Install for Linux

Install for Node.js

Upgrade Allure

Working With Reports

How to generate a report

How to view a report

Improving readability of your test reports

Improving navigation in your test report

Features

Test steps

Attachments

Test statuses

Sorting and filtering

Defect categories

Visual analytics

Test stability analysis

History and retries

Timeline

Export to CSV

Export metrics

Guides

JUnit 5 parametrization

JUnit 5 & Selenide: screenshots and attachments

JUnit 5 & Selenium: screenshots and attachments

Setting up JUnit 5 with GitHub Actions

Pytest parameterization

Pytest & Selenium: screenshots and attachments

Pytest & Playwright: screenshots and attachments

Pytest & Playwright: videos

Playwright parameterization

Allure Report 3: XCResults Reader

How it works

Overview

Test result file

Container file

Categories file

Environment file

Executor file

History files

Integrations

Azure DevOps

Bamboo

GitHub Actions

Jenkins

JetBrains IDEs

TeamCity

Visual Studio Code

Frameworks

Behat

Getting started

Configuration

Reference

Behave

Getting started

Configuration

Reference

Codeception

Getting started

Configuration

Reference

CodeceptJS

Getting started

Configuration

Reference

Cucumber.js

Getting started

Configuration

Reference

Cucumber-JVM

Getting started

Configuration

Reference

Cucumber.rb

Getting started

Configuration

Reference

Cypress

Getting started

Configuration

Reference

Jasmine

Getting started

Configuration

Reference

JBehave

Getting started

Configuration

Reference

Jest

Getting started

Configuration

Reference

JUnit 4

Getting started

Configuration

Reference

JUnit 5

Getting started

Configuration

Reference

Mocha

Getting started

Configuration

Reference

Newman

Getting started

Configuration

Reference

NUnit

Getting started

Configuration

Reference

PHPUnit

Getting started

Configuration

Reference

Playwright

Getting started

Configuration

Reference

pytest

Getting started

Configuration

Reference

Pytest-BDD

Getting started

Configuration

Reference

Reqnroll

Getting started

Configuration

Reference

REST Assured

Getting started

Configuration

Robot Framework

Getting started

Configuration

Reference

RSpec

Getting started

Configuration

Reference

SpecFlow

Getting started

Configuration

Reference

Spock

Getting started

Configuration

Reference

TestNG

Getting started

Configuration

Reference

Vitest

Getting started

Configuration

Reference

WebdriverIO

Getting started

Configuration

Reference

xUnit.net

Getting started

Configuration

Reference

On this page

Allure Report Documentation ​

Allure Report is an open-source framework-agnostic test result visualization tool. It transforms test execution data into clear, interactive HTML reports. It works with popular testing frameworks across JavaScript, Python, Java, C#, PHP, and Ruby, helping teams track test results and better manage software quality.

TIP

If you're new to Allure and want to learn how to install it, it's best to begin with the Getting Started section, which has guides for:

  • Allure Report 3 - the newer version rebuilt from the ground up for better usability and compatibility. Currently in Beta.
  • Allure Report 2 - the stable, mature version of the reporting tool, with the largest range of integrations.

Most documents here apply to Allure Report versions 2 and 3 both. Where that is not the case, the document is marked with Allure 3 and Allure 2 badges.

What You'll Find Here ​

Features ​

Explore Allure's core capabilities that make test reporting powerful and insightful. Learn about test steps, attachments, visual analytics, timeline views, and advanced filtering options that help you understand your test results at a glance.

Guides ​

Step-by-step tutorials for common use cases and popular tool combinations.

How It Works ​

Learn about the core concepts behind Allure and understand how Allure processes your test data to generate beautiful reports.

Integrations ​

Find setup instructions for popular CI/CD platforms like Jenkins, GitHub Actions, Azure DevOps, and development environments including JetBrains IDEs and Visual Studio Code.

Frameworks ​

Comprehensive integration guides for 30+ testing frameworks across multiple programming languages. From JavaScript (Jest, Mocha, Cypress) to Java (JUnit, TestNG, Cucumber-JVM), Python (pytest, Behave), .NET (NUnit, xUnit), and many more - find the exact setup for your tech stack.


Getting Started? If you're new to Allure, check out our Getting Started guides for the latest Allure 3 or the current stable version Allure 2.

Need a Quick Start? Try our Starter Project generator to create a ready-to-use project with Allure already configured for your preferred language and framework.

Pager
Next pageAllure 3: Getting Started
Powered by

Subscribe to our newsletter

Get product news you actually need, no spam.

Subscribe
Allure TestOps
  • Overview
  • Why choose us
  • Cloud
  • Self-hosted
  • Success Stories
Company
  • Documentation
  • Blog
  • About us
  • Contact
  • Events
© 2025 Qameta Software Inc. All rights reserved.