Allure Report installation

allure-commandline maven latest version

Allure Report is the utility that processes test results collected by a compatible test framework and produces an HTML report. This page lists various way to install Allure Report.

Install via Homebrew (for macOS and Linux)

  1. Make sure Homebrew is installed.

  2. In a terminal, run this command:

    Bash
    brew install allure

Install via Scoop (for Windows)

  1. Make sure Scoop is installed.

  2. Make sure Java version 8 or above installed, and its directory is specified in the JAVA_HOME environment variable.

  3. In a terminal, run this command:

    Bash
    scoop install allure

Install via the system package manager (for Linux)

  1. Go to the latest Allure Report release on GitHub and download the allure-*.deb or allure-*.rpm package, depending on which package format your Linux distribution supports.

  2. In a terminal, go to the directory with package and install it.

    • For the DEB package:

      Bash
      sudo dpkg -i allure_2.24.0-1_all.deb
    • For the RPM package:

      Bash
      sudo rpm -i allure_2.24.0-1.noarch.rpm

Install as a Node.js package (for any system)

  1. Make sure Node.js and NPM are installed.

  2. Make sure Java version 8 or above installed, and its directory is specified in the JAVA_HOME environment variable.

  3. In a terminal, go to the root directory of gthe project for which you want to use Allure Report. Run this command:

    Bash
    npm install --save-dev allure-commandline
    Bash
    yarn add --dev allure-commandline
    Bash
    pnpm install --dev allure-commandline

Note that with this installation method, Allure Report only becomes available in the given project's directory. Also, the commands for running Allure Report must be prefixed with your Node.js package manager's command, for example:

Bash
npx allure-commandline serve
Bash
yarn dlx allure-commandline serve
Bash
pnpx allure-commandline serve

Install from an archive (for any system)

  1. Make sure Java version 8 or above installed, and its directory is specified in the JAVA_HOME environment variable.

  2. Go to the latest Allure Report release on GitHub and download the allure-*.zip or allure-*.tgz archive.

  3. Uncompress the archive into any directory. The Allure Report can now be run using the bin/allure or bin/allure.bat script, depending on the operating system.

Note that with this installation method, the commands for running Allure Report must contain with the full path to the script, for example:

Bash
D:\Tools\allure-2.24.0\bin\allure.bat serve
Powered by
logo

Join our newsletter

Join our community

We aim to make Allure Report as reliable and user-friendly as possible, and together with the community, we're here to help when problems arise.

© 2024 Qameta Software Inc. All rights reserved.