This reporter creates TestRail reports. The first thing you need is to enable the TestRail API so that report can communicate with TestRail and push the test results. To do so, log into your TestRail account and go to Administration > Site Settings > API and make sure you click the checkbox near Enable API.

To use the reporter, add it to your package.json:

npm i --save-dev @wdio/testrail-reporter

Add the reporter to your WDIO config file:

export const config = {
    // ...
    reporters:
        [
            ['testrail', {
                projectId: 1,
                suiteId: 1,
                domain: 'xxxxx.testrail.io',
                username: process.env.TESTRAIL_USERNAME,
                apiToken: process.env.TESTRAIL_API_TOKEN,
                runName: 'name for the test run',
                oneReport: true,
                includeAll: false
            }
        ]
    ],
    // ...
}

ID of the testrail project.

Type: string

ID of the suite, suite 1 is default.

Type: string

Domain of your testrail instance, e.g. your-domain.testrail.io.

Type: string

Username of your testrail instance.

Type: string

API token of your testrail instance.

Type: string

Custom name for the test run.

Type: string

Create a single test run.

Type: boolean

Include all tests in suite in test run.

Type: boolean

For more information on WebdriverIO see the homepage.