Skip to main content

Using saucectl

saucectl is a command line interface that performs the underlying business logic to access the tests in your existing framework, run them (either in the Sauce Labs Cloud or locally in a Docker image), then securely transmit the test assets to the Sauce Labs platform, where you can review, share, and evaluate your test outcomes at scale.

What You'll Need#

Supported Frameworks and Browsers#

saucectl currently supports:

Supported Frameworks in Sauce Cloud#

Cypress VersionSupported PlatformsSupported Browsers
8.3.0Windows 10Chrome, Firefox, MicrosoftEdge
7.7.0Windows 10Chrome, Firefox, MicrosoftEdge
7.3.0Windows 10Chrome, Firefox, MicrosoftEdge
7.1.0Windows 10Chrome, Firefox, MicrosoftEdge
6.6.0Windows 10Chrome, Firefox, MicrosoftEdge
5.6.0Windows 10Chrome, Firefox, MicrosoftEdge

Supported Frameworks in Docker Runner#

Browser support for each framework is based on the Sauce Labs docker images provided in the saucectl installation. Each Docker image tag is the latest image that supports the specific framework version, as detailed in the available release notes.

Cypress VersionSupported Browsers
8.3.0Please see release notes
7.7.0Please see release notes
7.3.0Please see release notes
7.1.0Please see release notes
6.6.0Please see release notes
5.6.0Please see release notes

How to Get Started#

The rest of the saucectl documentation will guide you through the process of installing and configuring the saucectl command line, and then using it to run your tests in the way that best suits your current development process. At a high level, you will:

  1. Download and install saucectl.
  2. Generate and configure your saucectl working directory.
  3. Run a sample test to verify functionality.

Once you are confident that saucectl is running, you can customize your configurations based on your testing objectives. The following sections offer some common scenarios.

Existing Tests#

If you already have existing tests in your project (in cypress for example), once you install saucectl, you can just directly modify the default configuration file, and then run your existing tests.

Pipeline Tests#

If you wish to run saucectl as part of your DevOps CI toolchain, you can add it in your workflow by following one of our CI integration guides.

Sample Repos#

If you would like to see sample tests and configuration files for particular frameworks, you can clone one of our demo repositories for use as a template: