Tunnel CLI Arguments

The TestingBot Tunnel is a jar file which requires Java to run. When you open a terminal and navigate to the directory containing the tunnel jar, you can start the tunnel with a simple command:

java -jar testingbot-tunnel.jar {key} {secret}

Both the key and secret arguments are mandatory. There are more options you can pass in as well (run -h to see these), which we will cover below.

TestingBot Tunnel Options

Basic Authentication

-a or --auth <host:port:user:password> Allows you to specify a username and password to be used with Basic Authentication during testing for a specific host and port.

Debug

-d or --debug Will enable more verbose logging, which might help with troubleshooting potential problems with the Tunnel.

Custom DNS

-dns or --dns IP You can use a custom DNS server for requests passing through the tunnel.

Doctor

--doctor will help you troubleshoot any potential problems that might indicate a misconfiguration.

Tunnel Identifier

You can start multiple tunnels, each with their own identifier (-i or --tunnel-identifier <id>), which can be used by other team members in your organization.

Log file

-l or --logfile <FILE> specifying this will write all output logs generated by the tunnel process to the specific file.

You can find a full overview of all the possible CLI arguments.

Graceful exit

To stop the tunnel at the end of your testing, simply send a KILL signal to the process id (pid) of the tunnel:

kill $(ps aux | grep testingbot-tunnel | awk '{print $2}')