gurock/TestRail CLI
Use the TestRail CLI to interact with TestRail
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| trcli_version | Version of the CLI to be installed (defaults to latest) | no | — |
| config | Optional path for config yml file | no | — |
| host | TestRail host URL (i.e.: https://my-instance.testrail.io) | yes | — |
| username | Authentication username | yes | — |
| password | Authentication password or API key | yes | — |
| project | Name of the project (alternatively, use the "project_id" parameter) | no | — |
| project_id | ID of the project (alternatively, use the "project" parameter) | no | — |
| verbose | Output all API calls and their results (default: false) | no | — |
| verify | Verify the data was added correctly (default: false) | no | — |
| insecure | Allow insecure requests (default: false) | no | — |
| batch_size | Configurable batch size (default: 50) | no | — |
| timeout | Batch timeout duration (default: 30) | no | — |
| auto_create_cases_yes | Automatically create unexisting test cases (true/false) | no | — |
| auto_create_cases_no | Skip creation of unexisting test cases (true/false) | no | — |
| silent | Silence output (default: false) | no | — |
| report_file_path | Path to the JUnit XML file | yes | — |
| title | Title of Test Run to be created in TestRail | yes | — |
| case_matcher | Mechanism to match cases between the JUnit report and TestRail (auto/name/property, default: auto) | no | — |
| close_run | Close the newly created run (default: false) | no | — |
| suite_id | Suite ID where the run will be created in case of a multi-suite project | no | — |
| run_id | Run ID to submit results to (by default a new Test Run is created) | no | — |
| plan_id | Plan ID with which the Test Run will be associated | no | — |
| config_ids | Comma-separated configuration IDs to use along with Test Plans (i.e.: 34,52) | no | — |
| milestone_id | Milestone ID to which the Test Run should be associated to | no | — |
| section_id | Section ID to create new sections with test cases under | no | — |
| run_description | Summary text to be added to the test run | no | — |
| special_parser | Optional special parser option for specialized JUnit reports | no | — |
| allow_ms | Enable milliseconds for elapsed times (default: false) | no | — |
| junit_parser_params | Any parameters, as you would write them on a command line (i.e.: --case-fields type_id:1) | no | — |
| working_directory | The working directory to execute the TestRail CLI | no | — |
Outputs
no outputs