Test Automation with TestRail CLI
This wiki is your quick reference to TestRail’s automation features. It doesn’t replace the full documentation—instead, it acts as a guided index with short descriptions and direct links to the official articles on our Support site. Whether you’re setting up the TestRail CLI, connecting frameworks, or embedding results into your CI/CD pipelines, this page gives you the fastest path to the right resource.
The CLI is the foundation of TestRail automation. Use it to send test results, manage runs, or attach files directly from your development and testing workflows.
- Getting Started with the TestRail CLI – How to install, configure, and authenticate the CLI.
- Code-first workflow – Define tests in code and sync results automatically to TestRail.
- Specification-first workflow – Create and manage tests in TestRail first, then link to your automation.
- JUnit to TestRail mapping – Map JUnit XML output into TestRail’s test case and result structure.
- Usage examples – Real-world examples showing common CLI commands in action.
- SauceLabs and saucectl reports – Send SauceLabs and saucectl results into TestRail via CLI.
- Parameter Sources – Manage environment variables, config files, and other parameter sources.
- CLI commands reference – Complete list of available commands and options.
TestRail works hand-in-hand with a wide range of test frameworks. These guides show you how to connect your preferred tool so results flow seamlessly into TestRail.
- Integrate with Curiosity Quality Modeller
- Integrating with Ranorex
- Integrating with K6
- Integrating with Postman
- Integrating with WebdriverIO
- Integrating with JMeter
- Integrating with Selenium
- Integrating with Cypress
- Integrating with Playwright
- Integrating with JUnit5
- Integrating with TestNG
- Integrating with NUnit
- Integrating with Pytest
- Integrating with Robot Framework
- Integrating with Robot Framework (using Robot parser)
Bring TestRail into your delivery pipeline. From Jenkins to GitHub Actions and beyond, these articles explain how to publish results automatically with every build.
- Integrating with Jenkins (freestyle)
- Integrating with Jenkins (pipeline)
- Integrating with GitHub Actions
- Integrating with GitLab CI/CD
- Integrating with Azure Pipelines
- Integrating with CircleCI
- Integrating with Bitbucket
- Integrating with Travis CI
UI scripts let you extend TestRail’s interface with custom JavaScript, HTML, or CSS. They’re a powerful way to add buttons, automate repetitive actions, or connect TestRail to other tools in your workflow. For example, you can create quick links that trigger automated runs, highlight important fields, or pull in data from external systems. Learn how to set up and manage these scripts in the UI scripts for test automation guide.