🧪 allure-tldr

Allure Summary CLI

A blazing-fast, zero-config CLI tool to instantly generate beautiful executive summaries and human-friendly test statistics from your Allure results folder.

Perfect for instantly turning complex test results into simple, crystal-clear summaries anyone can understand—no tech jargon, just the facts!

Features

• 📦 EXECUTIVE SUMMARY just that's needed
• The story (RESULTS BREAKDOWN) in colored boxes
  • 📊 Bullet-pointed test stats (passed, failed, broken, skipped, etc.)
• Reads custom Environment details from environment.properties generated by allure
• 🛠️ Customizable box style and background colors
• 🆘 CLI help menu

Installation

npm install allure-tldr

Usage

npx allure-tldr --results ./allure-results

Or with custom options:

npx allure-tldr --results ./custom-results --padding 1 --margin 2 --borderStyle single --summaryBorderColor green --storyBorderColor blue

CLI Options

  --results, -r           Path to allure-results folder (default: allure-results)
  --padding               Inside Box padding (default: 2)
  --margin                Outside Box margin (default: 1)
  --borderStyle           Box border style (options: single, double, round, bold, classic; default: bold)
  --summaryBorderColor    Executive summary box border color (default: yellow)
  --summaryBg             Executive summary box background color (default: #fffbe6)
  --storyBorderColor      Story box border color (default: magenta)
  --storyBg               Story box background color (default: #f3e6ff)
  --titleAlignment        Box title alignment (options: left, center, right; default: center)
  -h, --help              Show help

Example Output

---

Made with ❤️ for readable test reporting!