Cucumber uses reporter plugins to produce reports that contain information about what scenarios have passed or failed.

Some plugins are built-in, others have to be installed separately. You can also build your own.

Built-in reporter plugins

Other reporter plugins

Cucumber Pro

This plugin publishes results to Cucumber Pro.


Your project must be stored in a Git repository, and you must be using one of the following CI servers:



Create a file called cucumber.yml in the root directory of your git repository with the following contents (replace *** with actual values).

  # The name of the Cucumber Pro project.
  # You can leave this blank if your Cucumber Pro project name is identical to the
  # CI project name, and you you're using one of Bamboo, Circle CI, TFS, Travis
  # or Wercker.
  projectname: ***
  # The URL of the Cucumber Pro server.
  # You can leave this blank if you are publishing to
  url: ***


If you are publishing to you also have to define an environment variable named CUCUMBERPRO_TOKEN in your CI project. The value should be your Cucumber Pro project’s API token, avaiable from the project settings page. Consult your CI server’s documentation for details about how to define environment variables.

Authentication is not required on a privately hosted Cucumber Pro Appliance.


The plugin will activate itself automatically if it detects that it’s running in one of the supported CI environments. When you run from your workstation the plugin will not be activated, and will not publish results.

When you configure the plugin for the first time you can force-activate the plugin from your work station by defining the following environment variables:

  • GIT_COMMIT - you can find it by running git rev-parse HEAD
  • GIT_BRANCH - you can find it by running git rev-parse --abbrev-ref HEAD

This is useful for verifying that you have configured the plugin correctly.


If you run several times as part of your build (with different options, perhaps different tags), you can specify a different profile name for each run. This allows Cucumber Pro to show separate results for each profile.

The profile name can be specified in the CUCUMBERPRO_PROFILE environment variable, which you would typically define in a wrapper script that launches .

Advanced configuration

The cucumber.yml configuration file has more options that can be overridden for finer grained control. The defaults are as follows:

  # The name of the Cucumber Pro project.

  # The project-specific authentication token. You can find it in the project settings (press `?` to display it).
  # Rather than defining the value in this file we recommend defining the `CUCUMBERPRO_TOKEN` environment variable
  # in your CI server.
  # Consult your CI server's documentation for details about defining per-project environment variables.
  # Some CI servers such as Travis and Circle CI allow you to define environment variables in a file checked into git.
  # *DO NOT DO THIS* - as it would allow anyone with read acceess to your repository to publish results.

  # The plugin sends your local environment variables to Cucumber Pro so it can detect the CI build number,
  # git branch/tag and other information about the build. This mask is a regular expression for filtering
  # out sensitive values that should not be sent to Cucumber Pro.

  # Sets the log level to one of `DEBUG`, `INFO`, `WARN`, `ERROR` or `FATAL`. Defaults to `WARN`.
  # Setting it to `DEBUG` will also print the current configuration when the plugin runs.
  logging: INFO

  # Writes out the log messages to the specified file. Useful for debugging.

  # Override this if you are using a privately hosted Cucumber Pro Appliance.
  # We recommend setting this with a CUCUMBERPRO_URL environment variable defined globally on your build server.

    # Set this to false if you want the build to break in case Cucumber Pro is unavailable.
    ignoreerror: true

    # If the http connection for publishing results takes longer than this (milliseconds),
    # time out the connection.
    timeout: 5000

You can make some of the settings global by creating a file wit global settings. The plugin will load the configuration in all the following files (if they exist):

Every setting can also be overridden with environment variables. For example, if you want the plugin to log more verbosely:

# Linux / OS X

# Windows

You can help us improve this documentation. Edit this page.