Sauce Connect Command Line Reference

-u

 --user <username>

Instead of explicit <username> you can also use the environment variable SAUCE_USERNAME on the command line.

 --api-key <api-key>

Instead of explicit <api-key> you can also use the environment variable SAUCE_ACCESS_KEY on the command line.

-c

 --config-file <path>

Version 4.5.0 and above.

Local path to a YAML file containing Sauce Connect configuration. Please refer to the following sample YAML file for more information.

The below line shows the order of precedence when the same argument is provided through multiple methods. Methods to the left have higher precedence.

Command Line Argument > Config File > Environment Variable

It is recommended to use a configuration file than command line arguments in production environments for the following reasons:

• Ability to track configuration changes.
• Easier to manage tunnel-domains and direct-domains options that can get very long.
• Secure Sauce Connect credentials with tighter access control on the config file

 --no-ssl-bump-domains <...>

Comma-separated list of domains. Requests including hosts that matches one of these domains will not be SSL re-encrypted. See the section on SSL Bumping Enabled by Default in the Troubleshooting Sauce Connect topic for more information about situations in which you would want to use this command.

 --no-proxy-caching

Disable caching in Sauce Connect. All requests will be sent through the tunnel.

-M

 --max-missed-acks <...>

The maximum amount of keepalive acks that can be missed before the client will trigger a reconnect. The default is 30.

 --direct-domains <...>

Comma-separated list of domains. Requests including hosts that matches one of these domains will be relayed directly through the Internet, instead of through the Sauce Connect tunnel.

 --tunnel-domains <...>

Inverse of --direct-domains. Overrides --direct-domains. Only requests for domains in this list will be sent through the Sauce Connect tunnel.

 --verbose

Enable verbose debugging. -vv will output HTTP headers and KGP logs. From version 4.4.3, -v will also output HTTP headers.

 --fast-fail-regexps <...>

Comma-separated list of regular expressions. Requests with URLs matching one of these will get dropped instantly and will not go through the tunnel. See the question How Do I Use Sauce Connect to Test Graceful Degradation in the Sauce Connect FAQs for an example of how you would use this command to test for application or site degradation based on missing assets or resources.

 --tunnel-identifier <id>

Assign <id> to this Sauce Connect instance. Future jobs will use this tunnel only when explicitly specified by the tunnel-identifier DesiredCapability in a Selenium client. Check out the topic Using Multiple Sauce Connect Tunnels for information on using tunnel-identifier to run multiple Sauce Connect tunnels simultaneously. Test Configuration Options contains more information about the syntax for setting tunnel-identifier as a DesiredCapability.

 --logfile <file>

Capture the Sauce Connect logs in <file>. If a path is not specified in <file>, the default location of the <file> is the same location where the Sauce Connect executable can be found on your machine.

 --se-port <port>

Port on which Sauce Connect's Selenium relay will listen for requests. Selenium commands reaching Sauce Connect on this port will be relayed to Sauce Labs securely and reliably through Sauce Connect's tunnel. Defaults to 4445.

 --proxy <host:port>

Proxy host and port that Sauce Connect should use to connect to the Sauce Labs cloud. See Sauce Connect Proxy with an Additional Proxy Setup for more information about using Sauce Connect with proxies.

 --proxy-userpwd <user:pwd>

Username and password required to access the proxy configured with -p. See   Sauce Connect Proxy with an Additional Proxy Setup for more information about using Sauce Connect with proxies.

 --pac <url>

Proxy autoconfiguration. Can be a http(s) or local file:// URL. See  Sauce Connect Proxy with an Additional Proxy Setup for more information about using Sauce Connect with proxies.

 --proxy-tunnel

Use the proxy configured with -p for the tunnel connection.See  Sauce Connect Proxy with an Additional Proxy Setup for more information about using Sauce Connect with proxies.

 --shared-tunnel

Allows sub-accounts of the tunnel owner to use the tunnel. See the question Can I Reuse a Tunnel Between Multiple Accounts? in the Sauce Connect FAQs for more information on using this command.

 --rest-url <arg>

By default Sauce Connect connects to "US virtual desktop and device cloud", use this option if you need to connect to a different Sauce Labs cloud.

• EU virtual desktop and device cloud - https://eu-central-1.saucelabs.com/rest/v1
• US real device cloud - https://us1.api.testobject.com/sc/rest/v1
• EU real device cloud - https://eu1.api.testobject.com/sc/rest/v1

 --readyfile

File that will be touched to indicate when the tunnel is ready.

 --auth <host:port:user:pwd>

Perform basic authentication when a URL on <host:port> asks for a username and password. This option can be used multiple times. Using --auth with Sauce Connect Proxy includes an example.

 --log-stats <seconds>

Log statistics about HTTP traffic every <seconds>. Information includes bytes transmitted, requests made, and responses received.

 --max-logsize <bytes>

Rotate logfile after reaching <bytes> size. Disabled by default.

 --doctor

Perform checks to detect possible misconfiguration or problems. Check out Troubleshooting Sauce Connect Proxy with --doctor for more information about the errors that --doctor will detect and how to resolve them.

 --no-autodetect

Disable the autodetection of proxy settings.

 --version

Display version information and exit.

 --reconnect <seconds>

Maximum time in seconds to wait between tunnel reconnect attempts.

 --scproxy-port <port>

Port to use for the built-in HTTP proxy.

 --cainfo <cainfo file>

CA certificate bundle to use for verifying REST connections.

 --capath <capath dir>

Directory of CA certs to use for verifying REST connections.

 --no-cert-verify

Disable certificate verification for REST connections.

--output-config

--daemonize

Go into the background after starting up.

--dns <server[,server..]>

--no-remove-colliding-tunnels

Don't remove identified tunnels with the same name, or any other default tunnels if this is a default tunnel. Jobs will be distributed between these tunnels, enabling load balancing and high availability. By default, colliding tunnels will be removed when Sauce Connect is starting up.

--wait-tunnel-shutdown

When shutting down, wait for all active jobs using the tunnel to finish. By default, Sauce Connect will force the shutdown of the tunnel even when there are active jobs.

--pidfile <file>

File to write Sauce Connect's process ID into. Useful for programmatically stopping Sauce Connect.

--metrics-address=address

host:port for the internal web server used to expose client side metrics. (default: localhost:8888)

--help

--extra-info '{"inject_job_id": true}'

Injects job id and tunnel id as HTTP request headers.