Local Testing with App Automate

Local Testing is a BrowserStack feature that helps you test mobile apps that access resources hosted in development or testing environments during automated test execution. This page will guide you through enabling Local Testing for App Automate sessions, and then using it to test apps that retrieve data from servers on your local machine, CI/CD machines/nodes, and other private network configurations.

Enabling Local Testing with App Automate is a simple two-step process:

  • Establishing a Local Testing connection.
  • Configuring test scripts so they run through the Local Testing connection.

1. Establishing a Local Testing connection

You can establish a Local Testing connection through your command-line interface by following the steps below:

  1. Download the BrowserStack Local binary for your system

    The download links are secure. The binaries are digitally signed, identifying the publisher as BrowserStack Limited for Mac users, and BrowserStack Inc. for Windows.

  2. Unzip the binary to a folder/directory on your machine.
  3. Open your command-line interface and navigate to the folder containing the Local binary.
  4. Run the binary using the following command
./BrowserStackLocal --key YOUR_ACCESS_KEY
BrowserStackLocal.exe --key YOUR_ACCESS_KEY

2. Configuring tests to run with Local Testing connection

After establishing the Local Testing connection, set browserstack.local capability to true in your Appium test script. This will ensure that your app can access resources (e.g. API server) hosted in your development or testing environments during automated test execution on BrowserStack devices.

Capability Description Value
browserstack.local Required if you are testing against internal/local servers true/false
Default Value: false


DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.local", "true");
Note: The binary connection needs to be established before creating a test session, and disconnected only after test execution is complete.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

Thank you for your valuable feedback