TestRail Reporter for Cypress
runs on TestRail.
$ npm install cypress-testrail-accumulative-reporter --save-dev
Add reporter to your
Your Cypress tests should include the ID of your TestRail test case. Make sure your test case IDs are distinct from your test titles:
it("C123 C124 Can authenticate a valid user", ...
it("Can authenticate a valid user C321", ...
it("C123Can authenticate a valid user", ...
it("Can authenticate a valid userC123", ...
domain name of your TestRail instance (e.g. for a hosted instance instance.testrail.com
email of the user under which the test run will be created.
password or the API key for the aforementioned user.
project with which the tests are associated.
suite with which the tests are associated.
(optional) name of the Testrail run.
To increase security, the TestRail team suggests using an API key instead of a password. You can see how to generate an API key here
If you maintain your own TestRail instance on your own server, it is recommended to enable HTTPS for your TestRail installation
For TestRail hosted accounts maintained by Gurock
, all accounts will automatically use HTTPS.
You can read the whole TestRail documentation here
Milutin Savovic - github
This project is licensed under the MIT license