Reporters

Reporters are plugins used to output test run reports in a certain format.

TestCafe ships with the following reporters:

You can also create a custom reporter that fulfills your needs.

Here are some custom reporters developed by the community.

For more information about the reporters, see the following sections.

Search for Reporter Plugins

Reporter plugins are npm packages. The reporter package name consists of two parts - the testcafe-reporter- prefix and the name of a reporter itself; for example, testcafe-reporter-list.

You can search for available reporter packages on npm: https://www.npmjs.com/search?q=testcafe-reporter.

Install the Reporters

You can install reporter packages from npm as you would install any other plugin. See Install Plugins.

Use the Reporters

When running tests, you can select a reporter to generate test reports. You can do this by using the -r (–reporter) command line option or the runner.reporter API method.