FAQ
Frequently asked questions
Short answers to the questions people ask first.
Is this an official Sauce Labs tool?
No. sauce-labs-cli is an independent, unofficial project. It is not affiliated with, endorsed by or sponsored by Sauce Labs.
Do I need a Sauce Labs account?
Yes. Every command calls the Sauce Labs API with your Username and Access key. This project cannot create an account for you, and there is nothing to sign up for on this site.
How do I install it?
From npm: npm install -g sauce-labs-cli, or pnpm add -g sauce-labs-cli. The published version is 0.1.0 and needs Node.js 20 or later. There is no Homebrew formula and no prebuilt binary release yet.
Where do my Credentials go?
Only to the Sauce Labs API host for the Region you choose, as HTTP basic auth. Set them as SAUCE_USERNAME and SAUCE_ACCESS_KEY, in a .env.local file you keep out of version control, or as flags.
Which Regions are supported?
us-west-1 (the default), us-east-1 and eu-central-1.
Why can’t I edit a Real-device job?
The Real Device Cloud API is read-only for job records, so sauce jobs edit works on Virtual-device jobs only. You can still list and inspect Real-device jobs with --real.
How do I get machine-readable output?
Add --verbose for the full API response as JSON, or --verbose --output yaml for YAML. Without --verbose, commands print only ids, one per line.
Still stuck? Contact us.