Skip to main content

Testiny CLI Reference

The CLI reference provides an overview of all available commands supported by the tool. It makes any integration into your CI/CD process very simple. Make sure you have reviewed all available options and settings to learn about all its features. If you are missing any options or features, feel free to contact us via email: [email protected]

Global Testiny CLI Help​

Usage: testiny-importer [options] [command]

Options:
  --app <url>                    App endpoint to use
  -P, --project <nameOrKey>      Target project id or key
  -y, --confirm                  Do not prompt for confirmation before starting import
  -q, --quiet                    Do not prompt for optional settings
  --disable-custom-fields        Disable custom field import. Will fail if required custom fields
                                 with no defaults are enabled
  --enable-custom-fields         Enable custom field import. Will fail if required custom fields
                                 with no defaults are enabled
  --disable-tc-keys              Disable test case import key hints (If enabled use #1234 or
                                 TC-1234 in title for referencing test cases)
  --disable-nested-folders       Disable nesting of imported folders (flat mode), applies to CSV
                                 files only
  --enable-nested-folders        Enable nesting of imported folders (flat mode), applies to CSV
                                 files only
  --folder-separator <token>     Token for folder name separation (default empty = automatic)
  --markdown                     Enable Markdown conversion
  --skip-invalid                 Skip invalid test cases (default: false)
  --duplicates <duplicate mode>  Controls how duplicates are detected (choices: "off", "title",
                                 "folder_title", default: "folder_title")
  --apikey <apiKey>              The API key to use. Not recommended - use the environment variable
                                 TESTINY_API_KEY or TESTINY_IMPORT_API_KEY instead
  -h, --help                     display help for command

Commands:
  testcase [options]             Import test cases (with folders)
  testrun [options]              Import test case results as a testrun
  licenses                       Show included package licenses
  help [command]                 display help for command

Testrun​

To submit results from automated tests to Testiny, use the testrun option. When importing test results, new test cases are created, if the respective test case does not already exist. Testiny supports a variety of different file formats from individual automation tools.

Please note: you can combine the options below with the global options.

Usage: testiny-importer testrun [options]

Import test case results as a testrun

Options:
  --csv <file>                             Import this CSV file
  --csv-encoding <encoding>                CSV file encoding (default: "utf8")
  --junit <file>                           Import this JUnit XML file
  --playwright <file>                      Import this Playwright JSON file
  --name <test run name>                   Name of the test run (use %date, %host and %source as placeholders)
  --update                                 Allow run with given name to be updated, otherwise creates a new run with that name (default: false)
  --close                                  Close the testrun after a successful import (default: false)
  --folder <folder name>                   Override folder name for all created test cases
  --testplan <nameOrKey>                   Target test plan id or title
  --junit-ignore-classname                 JUnit: do not include 'classname' attribute in test case title (default: false)
  --junit-classname-as-folder              JUnit: The 'classname' attribute is used for folder names and not the test case title (default: false)
  --junit-strip-classname-prefix <prefix>  JUnit: Remove the specified prefix string from classnames before processing
  --testcases <tc mode>                    Controls how test cases are created if no existing TC is found (choices: "ignore", "fail", "create", default: "create")
  -h, --help                               display help for command

Testcase​

To import test cases from other test management tools using .csv files, use the testcase option. The test case importing feature is able to import test cases with multiple steps using different formats.

Please note: you can combine the options below with the global options.

Usage: testiny-importer testcase [options]

Import test cases (with folders)

Options:
  --csv <file>                     Import this CSV file
  --csv-encoding <encoding>        CSV file encoding (default: "utf8")
  --trl <file>                     Import TestRail XML export
  --trl-api <server url>           Import from TestRail API
  --trl-user <user name>           Username/email for TestRail API
  --trl-export-users <file>        Export TestRail users to CSV file
  --trl-tc-limit <count>           Limits the number of test cases fetched
  --trl-rate-limit <rps>           Limits the number of requests to the
                                   TestRail api (default 160, zero for no
                                   limit)
  --steps <step mode>              Controls how steps are imported (choices:
                                   "auto", "off", "rows", "row_blocks",
                                   "newlines", "numbered", "numbered_bracket",
                                   "asterisk")
  --attachments <attachment mode>  Controls how test case attachments are
                                   imported (choices: "off", "inline", "all")
  -h, --help                       display help for command