Run your first test

Install the BrowserStack driver

Install @browserstack/mobilewright into your existing Mobilewright project:

Set your credentials

Export your BrowserStack Username and Access key as environment variables:

Configure the driver

A BrowserStack run uses the same mobilewright.config.ts as any other Mobilewright project, alongside your usual testDir and bundleId settings. Import browserStackDriver from @browserstack/mobilewright and assign it to driver:

browserStackDriver() accepts:

• app: the build under test. Give it a bs:// URL from a previous upload, a filesystem path to a local .apk or .ipa, or a public https:// URL. A local file is packaged and sent to BrowserStack the first time a run needs it, not on every run. If you omit app here, the driver falls back to the BROWSERSTACK_APP environment variable.
• project: a name that groups this run’s sessions together on the App Automate dashboard.
• username and accessKey: only needed here if you’d rather not rely on the BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY environment variables you set earlier.

Device selection itself still uses Mobilewright’s regular config fields: deviceName matches a device name against a regex pattern, osVersion accepts a range expression such as ">=17 <19", and deviceType is always real for App Automate.

The rest of the file is standard Mobilewright test-runner configuration, unrelated to the driver. See the Mobilewright configurations reference for the config file resolution order, testMatch, timeout, reporter, and the use and expect blocks.

Run your test

A local .apk or .ipa referenced by your config is packaged and uploaded the first time a BrowserStack run needs it. When the driver is BrowserStack’s, Mobilewright also skips the mid-session app reinstall step it normally performs between local test runs.

A few other flags come in handy once you’re past your first run: