CLI Reference
Command
allure-report build --results <path> --out <path> [options]
Required options
| Option |
Description |
--results |
Path to allure-results directory. |
--out |
Output directory for generated files. |
| Option |
Values |
Default |
--format |
html, pdf, docx, both |
both |
Allure generation options
| Option |
Description |
--allure-binary |
Explicit path to the Allure executable. |
--single-file |
Pass --single-file to allure generate when supported. |
--keep-html |
Keep generated allure-report-html (default). |
--discard-html |
Remove generated allure-report-html after export. |
| Option |
Description |
--title |
Report title. |
--project |
Project name. |
--build-url |
CI build URL. |
--commit |
Commit SHA/reference. |
--branch |
Branch name. |
--environment KEY:VALUE |
Repeatable metadata entries. |
Content/rendering options
| Option |
Description |
--include-attachments |
Include attachments (default true). |
--no-include-attachments |
Disable attachment rendering/listing. |
--max-tests |
Cap per-test detail count (default: 200). |
--logo-path |
Logo image path for report cover/header. |
--footer-text |
Footer text for report pages. |
--template-file |
Custom Jinja2 template path for print HTML. |
--css-file |
Custom CSS path for print HTML styling. |
Logging
| Option |
Values |
Default |
--log-level |
DEBUG, INFO, WARNING, ERROR |
INFO |