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 start with these sections, which have installation and getting started guides for:
- Allure Report 3 - the newer version rebuilt from the ground up for better usability and compatibility.
- 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 previous widely used Allure 2 version.
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.