axe DevTools Reporter CLI

Link to axe DevTools Reporter CLI copied to clipboard

Generate stand alone reports from your axe DevTools Mobile scans.

axe DevTools Command Line Interface (CLI)

Generate stand alone reports from axe DevTools Mobile to share with your team - licensed user or not.

tip

Checkout our guide to Generate Reports with CI/CD.

Is your team already using the axe DevTools CLI? It now supports generating HTML reports from axe DevTools Mobile scans. Provide the CLI a directory that contains your mobile scans as JSON files.

JSON files can be obtained from two sources:

  1. Exporting scans from the axe DevTools Mobile dashboard
  2. Saving results locally within your automated test run

See the axe DevTools CLI documentation for more information.

axe DevTools Reporter CLI

axe DevTools Reporter CLI has taken the reporting power available in axe DevTools CLI and brought it into a lightweight, standalone CLI. The Reporter is available as a direct download.

Direct Download

Find your operating system in the subsections below. Once the axe DevTools Reporter CLI is downloaded from Deque's Artifactory, open the command line and navigate to the executable's location. Use the command below the download link to test the installation.

tip

Administrator Mode
Depending on your machine's configuration, you may need to use administrator mode.

Enable Global Installation
Make axe DevTools Reporter CLI available globally from any directory by placing it in a directory in your system's $PATH. You can see which directories are in your system's $PATH by running `echo $PATH`.

Download the latest release. Your download should be an executable, you may need to execute chmod +x <name> in terminal to make it so on Mac or Linux machines.

On Windows

Test the installation with:

./reporter-cli-win.exe --help

On Linux

Test the installation with:

./reporter-cli-linux --help

On macOS

Test the installation with:

./reporter-cli-macos --help

Generating Reports

Once you gather axe DevTools Mobile scans as JSON files, you're ready to build a report. Ensure all the scans are in a directory, then run the following command to generate the HTML reports:

axe-devtools-reporter <devtools-results-directory> <output-directory> --format=html

The reports are stored in ./axe-devtools-reporter by default unless an output directory was provided. The output directory can also be specified using the flag -d —destination [path].

Filenames are derived from the scan name and the scan's analysis timestamp. ${scanName}-axe-result-${timestamp}.html

tip

Be sure to checkout executive-report.html to view the combined results of all scans within the suite.

Output Format

In addition the HTML report, you may also export the data for CSV, or XML/JUnit.

HTML:

axe-devtools-reporter <devtools-results-directory> <output-directory> --format=html

XML/JUnit:

axe-devtools-reporter <devtools-results-directory> <output-directory> --format=junit

CSV:

axe-devtools-reporter <devtools-results-directory> <output-directory> --format=csv

Is this page helpful?

Help us improve this page

Still need help?