Getting Started

Universal Prerequisites

To start with make sure you have a valid Sauce Labs account

Since credentials should never be stored in code that might get added to a version control system, we have decided to require users of Sauce Bindings to store these values in environment variables:

SAUCE_USERNAME='valid.username'
SAUCE_ACCESS_KEY='valid.key'

Here are instructions for setting environment variables on each Operating System:

Language Specific Prerequisites


  1. Install Java version 8 or greater
  2. Install your favorite Java IDE (we really like IntelliJ and the Community Edition is free).
  3. The project is designed as a standard Maven project and follows Maven conventions.
    Add the following to your .pom file:
<!-- https://mvnrepository.com/artifact/com.saucelabs/sauce_bindings -->
<dependency>
    <groupId>com.saucelabs</groupId>
    <artifactId>sauce_bindings</artifactId>
    <version>1.0.1</version>
</dependency>

Examples in the docs are written to use JUnit 4, so to execute the examples you must also add this to your .pom file:

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13</version>
</dependency>


  1. Install the package:
pip install saucebindings
  1. Import it into your project
from saucebindings.options import SauceOptions
from saucebindings.session import SauceSession


  1. Add it to your Gemfile:
gem 'sauce_bindings'
  1. Require it in your project:
require 'sauce_bindings'

If you are using Capybara, you must also require this file:

require 'sauce_bindings/capybara_session'

Examples on this site are written to use RSpec, so to execute them you must also add this to your Gemfile:

gem 'rspec'


C# bindings are coming soon...

← OverviewCreate Session →