Skip to main content

Puppeteer Quickstart

Use saucectl -- the Sauce Labs test orchestrator CLI to run Puppeteer tests directly from your existing Puppeteer project.

  • Don't have Puppeteer tests but want to try? The Puppeteer Demo Repo includes a sample project structure, working configuration file, and sample Puppeteer test so you can get up and running in less than 10 minutes!
  • Already running Puppeteer? Let saucectl run your tests in Docker and then publish the results in your Sauce Labs account, where you can easily analyze 30 days worth of test results and data analytics.

What You'll Need#


Ensure the Docker daemon is running (e.g., docker info works in your terminal / command prompt)

Step 1: Install saucectl#

npm install -g saucectl

Step 2: Link Your Sauce Labs Account#

saucectl requires access to a valid Sauce Labs account.

  1. Run the configure command:
    saucectl configure
  2. Enter your Sauce Labs Username and Access Key at the prompts.
Use Environment Variables

You can set your Sauce Labs credentials as environment variables instead of generating a credentials.yml, if you prefer. In systems where both sets of credentials exist, environment variable values are prioritized.

Step 3: Set up Your Puppeteer Project#

Check out the Puppeteer Demo Repo to get a Puppeteer project structure, Puppeteer-ready configuration file, and sample Puppeteer test.

Step 4: Run Tests#

Use the run command to execute the sample test included with the saucectl example.

saucectl run

The console displays the executing tests, confirming that Docker mode is running and the results and test assets are available immediately in your Sauce Labs account.