Install Plugins

The TestCafe functionality can be extended by using plugins and extensions. You can install existing plugins or develop custom ones that will suit your needs.

You can install plugins from npm in two ways:

• locally - if you are going to use plugins within TestCafe installed locally.

  Navigate to your project directory and run the following command.

  npm install --save-dev {pluginName}
  

• globally - if the TestCafe module is installed globally or you are going to use plugins within other projects as well.

  Run the npm install command with a -g flag.

  npm install -g {pluginName}
  

Create Plugins #

The following topics provide detailed information on creating the most widely used plugins and extensions.

• Reporter Plugin
• Browser Provider Plugin

Selected Plugins #

This section lists the most popular plugins. Plugins developed by the TestCafe team are officially supported and maintained.

Browser Providers

• SauceLabs (by the TestCafe team)
• BrowserStack (by the TestCafe team)
• CrossBrowserTesting (by @sijosyn)
• LambdaTest (by @kanhaiya15)
• Electron (by the TestCafe team)
• Puppeteer (by @jdobosz)

Framework-Specific Selectors

• React (by the TestCafe team)
• Angular (by the TestCafe team)
• Vue (by the TestCafe team)
• Aurelia (by the TestCafe team)

Plugins for Task Runners

• Grunt (by @crudo)
• Gulp (by @inikulin)

Custom Reporters

• TeamCity (by @nirsky)
• Slack (by @Shafied)
• NUnit (by the TestCafe team)

GitHub Actions

• Run TestCafe (by the TestCafe team)

IDE Plugins

• TestCafe Test Runner for Visual Studio Code (by @romanresh)
• TestLatte for Visual Studio Code (by @Selminha)
• TestCafe Runner for WebStorm (by @lilbaek)
• SublimeText (by @churkin)

More plugins are listed on the TestCafe GitHub page.