Have ideas to improve npm?Join in the discussion! »


2.1.0 • Public • Published

TestRail Reporter for Cypress

version downloads MIT License

Publishes Cypress runs on TestRail.


$ npm install cypress-testrail-milestone-reporter --save-dev


Add reporter to your cypress.json:

  "domain": "yourdomain.testrail.com",
  "username": "username",
  "password": "password",
  "projectId": "projectIdNumber",
  "milestoneId": "milestoneIdNumber",
  "suiteId": "suiteIdNumber",
  "createTestRun": "createTestRunFlag",
  "runName": "testRunName",
  "runId": "testRunIdNumber",
  "artifactsURL": "uploadedArtifactsLocation"

Your Cypress tests should include the ID of your TestRail test case. Make sure your test case IDs are distinct from your test titles:

// Good:
it("C123 C124 Can authenticate a valid user", ...
it("Can authenticate a valid user C321", ...
// Bad:
it("C123Can authenticate a valid user", ...
it("Can authenticate a valid userC123", ...

Reporter Options

domain: string domain name of your TestRail instance (e.g. for a hosted instance instance.testrail.com).

username: string email of the user under which the test run will be created.

password: string password or the API key for the aforementioned user.

projectId: number project with which the tests are associated.

milestoneId: number milestone with which the exectuted tests are associated.

suiteId: number (optional: required when TestRail project uses multiple test suites to manage cases) suite with which the tests are associated.

createTestRun: string yes if you want to create a new Test Run, no if you only update results to existed Test Run.

runName: string (optional: required when createTestRun = yes) name of the Testrail run.

runId: number (optional: required when createTestRun = no) Test Run id.

artifactsURL: string (optional) location of manually uploaded Test Video and Screenshot files.

TestRail Settings

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.


Sava Grkovic - github


This project is licensed under the MIT license.



npm i cypress-testrail-milestone-reporter

DownloadsWeekly Downloads






Unpacked Size

16.3 kB

Total Files


Last publish


  • avatar