Usage

After installation, verify that TDM CLI is accessible from your environment:

Bash

tdm

or on Windows:

Text Only

tdm.exe

If the command executes successfully, the CLI is ready to use.

Global Flags

--insecure

The --insecure flag disables SSL/TLS certificate validation.

Warning

Disabling certificate validation may expose the application to security risks such as man-in-the-middle attacks. This option should only be used in development or test environments with self-signed certificates.

Example:

Text Only

tdm <command> --insecure

Commands

Login

The login command authenticates the user and persists configuration in the tdm.conf file. This configuration is reused for subsequent executions.

Text Only

tdm login --endpoint "<endpoint>" \
          --username "<username>" \
          --password "<password>" \
          --expiration "<expiration_date>"

Insecure Mode

Text Only

tdm login --endpoint "<endpoint>" \
          --username "<username>" \
          --password "<password>" \
          --expiration "<expiration_date>" \
          --insecure

Case

The case command is used to execute individual test cases.

Run a Test Case with Parameters

Text Only

tdm case run --id <id> --param-path "</path/to/caseparams.json>"

Run a Test Case (Default Parameters)

Text Only

tdm case run --id <id>

Insecure Mode

Text Only

tdm case run --id <id> --param-path "</path/to/caseparams.json>" --insecure

Parameter File Format

The parameter file must be provided in JSON format as shown below:

Text Only

[
  {
    "Key": "testkey1",
    "Value": "2001-06-06",
    "DataType": "DATE"
  },
  {
    "Key": "testkey2",
    "Value": "1",
    "DataType": "NUMBER"
  }
]

Retrieve Flow Parameters

Use the following command to retrieve parameters based on flow name and type:

Text Only

tdm case flow --flowname <flowname> --flowtype <flowtype>

Insecure Mode

Text Only

tdm case flow --flowname <flowname> --flowtype <flowtype> --insecure

Suite

The suite command is used to execute test suites consisting of multiple test cases.

Run a Test Suite with Parameters

Text Only

tdm suite run --id <id> --param-path "</path/to/suiteparams.json>"

Run a Test Suite (Default Parameters)

Text Only

tdm suite run --id <id>

Insecure Mode

Text Only

tdm suite run --id <id> --param-path "</path/to/suiteparams.json>" --insecure

Suite Parameter File Format

Suite execution parameters must be defined in JSON format:

Text Only

[
  {
    "caseId": 1,
    "testCaseName": "TestSuite1",
    "caseParameterList": [
      {
        "key": "startDate",
        "value": "2022-01-01",
        "dataType": "DATE"
      },
      {
        "key": "limit",
        "value": "10",
        "dataType": "NUMBER"
      }
    ]
  },
  {
    "caseId": 2,
    "testCaseName": "TestSuite2"
  },
  {
    "caseId": 3,
    "testCaseName": "TestSuite3"
  }
]

Help

The help command provides detailed usage information for all commands and flags.

General Help

Text Only

tdm --help

Command-Specific Help

Text Only

tdm login --help
tdm case run --help
tdm case flow --help
tdm suite run --help

Summary

TDM CLI provides a streamlined and automation-friendly interface for executing test data workflows. It integrates easily with CI/CD pipelines, enabling consistent, repeatable, and scalable test data operations across environments.