tuskr v1.0.0

Tuskr CLI Tool Documentation

This document provides detailed information on the usage of our CLI tool, designed for importing test results from automation frameworks and CI tools.

Installation

Use NPM to install it:

npm install tuskr

Usage

To import a JUnit XML file into a project, run the following command:

tuskr --api-token YOUR_API_TOKEN --project PROJECT_AUTOMATION_ID --file "/path/to/file.xml" --test-run-name "My Test Run"

Options

• --command <type>: Specifies the type of command to execute. Default is "import-junit-xml". Example: import-junit-xml.
• --api-token <token>: Required. The API token of the user with admin access.
• --project <string>: Required. Project Automation ID, ID, Name, or External ID.
• --file <path>: Required. Path to the file (JUnit XML, BDD JSON, etc.).
• --test-run-id <string>: ID of the test run.
• --test-run-name <string>: Name of the test run.
• --test-run-external-id <string>: External ID of the test run.
• --test-run-deadline <date>: Deadline of the test run in ISO format.
• --test-run-assigned-to <email>: Owner of the test run.
• --attachments-path <path>: Directory path to search for attachments.
• --test-case-rules <path>: Path to the test case JSON rules file.
• --test-result-rules <path>: Path to the test result JSON rules file.
• --emails <email(s)>: Comma-separated emails of users to be notified when the task is completed.

Additional Notes

• Make sure your API token has the necessary permissions to perform the actions.
• Verify the path to your file and rules files are correct to avoid any file not found errors.
• For the --test-run-deadline option, ensure the date is in ISO format.