Skip to content

Quick Start

Input expectation

The tool expects a directory such as ./allure-results/ that was produced by your test framework and Allure adapter.

Generate all outputs

allure-report build --results ./allure-results --out ./allure-report-out --format both

Generated files:

  • allure-report-out/report.pdf
  • allure-report-out/report.docx
  • allure-report-out/report-print.html
  • allure-report-out/allure-report-html/

Build specific formats

# HTML artifacts only
allure-report build --results ./allure-results --out ./allure-report-out --format html

# PDF only
allure-report build --results ./allure-results --out ./allure-report-out --format pdf

# DOCX only
allure-report build --results ./allure-results --out ./allure-report-out --format docx

Add metadata

allure-report build \
  --results ./allure-results \
  --out ./allure-report-out \
  --format both \
  --title "Nightly Regression Report" \
  --project "Turnlamp" \
  --build-url "https://ci.example/jobs/412" \
  --branch "main" \
  --commit "abc1234" \
  --environment OS:Windows \
  --environment Browser:Chromium

Open official Allure HTML correctly

Allure report SPA should be opened through a web server, not direct file://.

allure open ./allure-report-out/allure-report-html

or

cd ./allure-report-out/allure-report-html
python -m http.server 8080

Then open http://localhost:8080.