Preflight CLI

Preflight is a code-free automated UI testing tool. This package allows you to run your Preflight tests in a CLI environment, providing a seamless integration into your development workflow.

Getting Started

To get started, you will need to obtain a client id and client secret from the Account Settings > API section of your Preflight account.

Installation

You can install the Preflight CLI package using the following command:

npm install -g @applitools/preflight-cli

Run

To be able to run any command, you need to provide clientId and clientSecret parameters.

preflight --clientId="<client-id>" --clientSecret="<client-secret>"

Run a Test

Provide testId parameter to run a test.

preflight --testId="<test-id>" --clientId="<client-id>" --clientSecret="<client-secret>"

Run a Group

Provide groupId parameter to run a group.

preflight --groupId="<group-id>" --clientId="<client-id>" --clientSecret="<client-secret>"

Run a Tag

Provide tags parameter to run tests by tags. (It could be either tag id or tag name)

preflight --tags="<tagId1>,<tagId2>" --clientId="<client-id>" --clientSecret="<client-secret>"

You can also provide groupId and tags together to filter tests by tags in a group.

preflight --groupId="<group-id>" --tags="<tagId1>,<tagId2>" --clientId="<client-id>" --clientSecret="<client-secret>"

Run a Workflow

Provide workflowId parameter to run a workflow.

preflight --workflowId="<workflow-id>" --clientId="<client-id>" --clientSecret="<client-secret>"

Run a Test Suite

Provide testSuiteId parameter to run a test suite.

preflight --testSuiteId="<test-suite-id>" --clientId="<client-id>" --clientSecret="<client-secret>"

Parameters

| Parameter | Description | Default Value | |------------------|---------------------------| ------------- | | --clientId | Preflight client id | | | --clientSecret | Preflight client secret | | | --environment| Environment to run tests in. (environmentId or URL) | null | | --captureScreenshots | Capture screenshots (Can only be used with test, group and tag run) | true | | --waitForResults| Wait for running tests to finish. | true | | --reportFilename| Report filename. | preflight-junit-report.xml | | --exitOnFail | Exit if any test fails. | false | | --apiUrl | API URL | Preflight API URL | | --authUrl | Auth URL | Preflight Auth URL |

License

This project is licensed under the terms of the MIT license. See the LICENSE file for license rights and limitations.