# Teamcity Reporter Reporter

> wdio-teamcity-reporter is a 3rd party package, for more information please see [GitHub](https://github.com/webdriverio-community/wdio-teamcity-reporter) | [npm](https://www.npmjs.com/package/wdio-teamcity-reporter)

WebdriverIO Teamcity reporter which makes it possible to display test results in real-time, makes test information available on the Tests tab of the Build Results page.

## Installation[​](#installation "Direct link to Installation")

```
npm install wdio-teamcity-reporter --save-dev
```

Instructions on how to install WebdriverIO can be found here: <https://webdriver.io/docs/gettingstarted>

## Configuration[​](#configuration "Direct link to Configuration")

Add reporter in your [wdio.conf.js](https://webdriver.io/docs/configurationfile/) file:

```
exports.config = {
  // ...
  reporters: [
    [
      'teamcity',
      {
        captureStandardOutput: false, // optional
        flowId: true, // optional
        message: '[title]', // optional
      }
    ]
  ],
  // ...
}
```

### Options[​](#options "Direct link to Options")

* `captureStandardOutput (boolean)` — if `true`, all the standard output (and standard error) messages received between `testStarted` and `testFinished` messages will be considered test output. The default value is `false` and assumes usage of testStdOut and testStdErr service messages to report the test output. Default `false`.
* `flowId (boolean)` — if `true`, `flowId` property will be added to all messages. Flow tracking is necessary for example to distinguish separate processes running in parallel. Default `true`.
* `message (string)` — possibility to provide particular format for the name property. Possible keys: `[browser]`, `[title]`. Example, `[browser] / [title]`. Default `[title]`.

## Links[​](#links "Direct link to Links")

* Reference to the Teamcity documentation about reporting messages: <https://confluence.jetbrains.com/display/TCD65/Build+Script+Interaction+with+TeamCity>
* Teamcity testdrive: <https://blog.jetbrains.com/teamcity/2019/08/getting-started-with-teamcity-testdrive/>

## License[​](#license "Direct link to License")

> The MIT License