Skip to content
sauce-labs-cli
Menu

Get started

Get started

There is nothing to sign up for on this site. You install the tool and use your own Sauce Labs account’s Username and Access key.

View on npmHow it works
  1. Step 1

    Install

    Install the sauce-labs-cli package globally with npm or pnpm, or run it once with pnpm dlx. The published version is 0.1.0 and needs Node.js 20 or later.

  2. Step 2

    Find your Credentials

    Your Username and Access key are under Account → User Settings in the Sauce Labs dashboard. You need a Sauce Labs account; this project cannot give you one.

  3. Step 3

    Set them in your environment

    Export SAUCE_USERNAME and SAUCE_ACCESS_KEY, and SAUCE_REGION if you are not on us-west-1. A .env.local file in the working directory works too; keep it out of version control.

  4. Step 4

    Run a command

    List your recent jobs or upload an App file. Add --verbose to see the full response.

Quickstart

npm install -g sauce-labs-cli        # or: pnpm add -g sauce-labs-cli

export SAUCE_USERNAME='your-username'
export SAUCE_ACCESS_KEY='your-access-key'
export SAUCE_REGION='eu-central-1'      # optional, default us-west-1

sauce jobs list --limit 5
sauce storage upload ./build/app.ipa
sauce --help

Install options that exist today

npm registry
sauce-labs-cli 0.1.0, with a `sauce` binary. Needs Node.js 20 or later.
One-off run
pnpm dlx sauce-labs-cli jobs list
Source version
0.2.0 on the main branch needs Node.js 24 or later and is not on npm yet. The source repository is private.
Prebuilt binaries
None released yet. A release workflow builds macOS binaries (arm64 and x64) on tagged releases; its Linux and Windows builds are turned off because there are no Linux or Windows build machines.
Homebrew
Not available.