# CLI

While clicking Run button button on the desired project, feature, scenario or flow works fine, that's unusable for continuous integration and continuous deployment.

For CI/CD, the CLI (opens new window) should be used.

# Installation

# Commands

# ping

Pings the TestSoothe server to ensure everything works fine. Response PONG indicates OK.

ping

# login

Authenticates a user to use other commands that require authentication. You'll need to have an account with TestSoothe (opens new window) to log in.

login

# whoami

Fetches the currently logged in user and displays the email address.

whoami

# logout

Logs the current user out.

logout

# projects

Requires login

Displays the projects the currently logged user has access to in a list from which a selection can be made.

projects

# features

Requires login

A project must have been selected.

Displays the features of the selected project in a list from which a selection can be made.

features

# scenarios

Requires login

A feature must have been selected.

Displays the scenarios of the selected feature in a list from which a selection can be made.

scenarios

# flows

Requires login

A project must have been selected.

Displays the flows of the selected project in a list from which a selection can be made.

flows

# selections

Displays all the active selections. Applying option -c or --clear clears all the selections.

selections

# key

Required to run tests

Displays the set runner key. The runner key with name default is set automatically on login, if the key exists.

key

If no key is set, the command prompts you to create and set one.

# run

Executes a test session on the selection.

run

The desired item to test can be specified with the available flags. Run testsoothe help run to see options.

# help

Displays helpful information on all commands. When a command is provided as an argument, it shows helpful information about the command only.

help

# CI/CD

In CI/CD, it is not practical to login and execute the commands one after the other. You can execute a test session with a single line which specifies what to test and the runner key.

run-ci-cd

In the example above, whoami indicates that nobody is logged in. Then a single line command executes test on a feature whose ID is FTR-NAU4-4.