BrowserStack SDK IDE Plugins: Setup and Usage

BrowserStack’s IntelliJ IDEA and Eclipse plugins help connect a Java test suite to BrowserStack SDK. In the documented Automate integration flow, the plugin guides you through choosing a project, framework, and BrowserStack parameters; it can add the browserstack-java-sdk dependency to a Maven project and generate browserstack.yml. Review those generated files, then run the tests using the instructions for your framework and build tool.

BrowserStack announced the IDE plugins on June 20, 2023, to simplify SDK integration for Java test suites. Its current Automate guides still document plugin flows for IntelliJ and Eclipse. See the announcement and the guides for TestNG and Selenide.

1. Check your project and workflow

Start with an existing Java automated test suite and decide which BrowserStack service and framework guide applies to it. The documented plugin workflows include Automate and Test Reporting & Analytics, with framework-specific guidance for projects such as TestNG, Selenide, JUnit 5, and Cucumber-related integrations. Instructions can differ by framework and by Maven or Gradle; use the matching BrowserStack guide rather than assuming one dependency or configuration works for every Java project.

Confirm the project is a Java test suite that uses a supported framework.
Identify whether it uses Maven or Gradle.
Choose the BrowserStack workflow you intend to configure, such as Automate.
Have your BrowserStack username and access key available for the configuration flow. Use credentials securely; do not commit a real access key to source control.

2. Install the IDE plugin

IntelliJ IDEA

Open Preferences on macOS or Settings on Windows and Linux. The label and location can vary by IDE version.
Open Plugins and search for BrowserStack.
Install the BrowserStack plugin. Restart the IDE if it prompts you to do so.
Open the Java test project you plan to integrate.

Eclipse

Open Help → Eclipse Marketplace.
Search for BrowserStack and install the plugin.
Restart Eclipse if prompted, then open the Java test project.

For the version-specific steps and screenshots, use the relevant official guide: TestNG integration or Selenide integration.

3. Integrate the project

From the project context menu, choose the BrowserStack integration action.
Select the project and the framework that match your test suite.
Enter the requested BrowserStack parameters. The guides show username and access-key placeholders; supply your account’s actual credentials through the intended configuration flow.
Let the integration complete, then inspect the project changes.

In the documented Java Maven integration path, the plugin adds the browserstack-java-sdk dependency and generates a browserstack.yml file. This describes that documented path, not a universal recipe for every framework or build system. Check the guide for your project before changing dependency declarations manually.

4. Review the generated configuration

Treat generated configuration as a starting point. Check the framework value, browser or platform entries, project and build labels, and credential handling. BrowserStack documents browserstack.yml as the SDK configuration location and describes platform configuration for cross-browser or cross-platform runs. When the same capability is set in both the test script and YAML file, the YAML value takes precedence.

The following is a shape check, not a complete runnable configuration: the exact fields and supported values depend on the framework and BrowserStack guide you selected. Keep the generated file from your integration and compare it with that guide rather than copying placeholder values into a real run.

# browserstack.yml (illustrative structure only)
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: YOUR_FRAMEWORK
platforms:
  - browser: YOUR_BROWSER
    os: YOUR_OPERATING_SYSTEM

Do not commit a real access key. If your team uses an existing secret-management method, follow it and the instructions for the chosen SDK workflow.

5. Run the suite and confirm the integration

Use the normal test-running workflow for the framework and build tool, following the matching BrowserStack integration guide.
Check the test output and BrowserStack run details for evidence that the expected project and platform configuration was used.
If the run does not reflect a value set in your test script, inspect browserstack.yml first because its value takes precedence when both locations define the same capability.
For a staging or development site reachable only inside your environment, consult the SDK’s Local Testing instructions.

BrowserStack describes its SDK as integrating with the test suite at runtime and supporting cross-browser or cross-platform execution, parallelization, and Local Testing for lower environments. These are vendor-described capabilities; available behavior and setup depend on the specific workflow. See How BrowserStack SDK works.

6. Know which BrowserStack IDE integration you need

The IntelliJ and Eclipse SDK plugin flow in this guide is for connecting Java automated tests. It is different from BrowserStack’s VS Code extension for launching BrowserStack Live browser sessions, and different again from Test Companion, which has its own product and installation guide.

Java test suite integration: use the SDK plugin flow and the framework-specific Automate or reporting guide.
Live browser sessions from VS Code: follow the separate BrowserStack Live VS Code integration.
Test Companion: follow its separate installation guide.

7. Troubleshooting

Symptom	Likely cause	What to do
BrowserStack does not appear in the plugin search or integration menu	The plugin is not installed, installation has not completed, or the IDE version uses different menu labels.	Check the IDE’s plugin manager or Eclipse Marketplace, complete any restart prompt, and use the official guide for your IDE and framework.
The integration offers the wrong project or framework	The wrong project is selected, or the suite’s framework is not the one chosen in the integration flow.	Reopen the project context action and select the intended project and framework. Check the framework-specific guide if your setup is not listed.
The dependency or generated YAML does not fit the project	The documented flow may differ for the project’s framework or Maven/Gradle build.	Use the exact BrowserStack guide for the framework and build tool. Avoid copying a Maven dependency snippet into a Gradle project or treating one framework’s fields as universal.
A capability appears to be ignored	The same capability may be configured in both the script and `browserstack.yml`.	Inspect the YAML value; BrowserStack documents that YAML takes precedence when both locations set the same capability.
Authentication fails	A username or access key may be missing, mistyped, or supplied in the wrong configuration location.	Check the credential values and the instructions for the selected integration. Use the account credentials and keep real secrets out of committed files.
Tests work locally but not against a private development or staging site	The remote test environment may not be able to reach the lower-environment application without the appropriate Local Testing setup.	Consult BrowserStack’s SDK documentation for Local Testing and configure it for the selected workflow.
You installed an extension but cannot find the Java SDK integration action	You may have installed the VS Code Live extension or Test Companion, which are separate workflows.	Install and use the IntelliJ or Eclipse SDK plugin described by the Java integration guide.

8. Performance, reliability, and cost considerations

The plugin is an integration aid; the selected BrowserStack service and SDK configuration determine the test run. BrowserStack documents parallelization and Local Testing as SDK capabilities, but the setup and behavior depend on the framework-specific workflow. Start with the configuration generated for your project, make one change at a time, and verify the resulting run before expanding platform coverage.

There are no plugin-specific performance benchmarks or cost figures in the sources for this guide. Check the current BrowserStack service and plan details for your account before planning concurrency or run volume. Keep credentials controlled and validate the target platform list so a configuration change does not unintentionally alter the scope of a run.

Or skip the browser setup

If your immediate task is capturing a page screenshot rather than running a Java browser test suite, ScreenshotNeo provides a website screenshot API and MCP server. A single GET request returns PNG, JPEG, WebP, or PDF. For example, this cURL call saves a WebP capture:

curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

See the ScreenshotNeo API documentation for parameters and response details. Cookie banners, newsletter popups, and chat widgets are removed before the shot; bot checks, blank pages, and failed loads are never billed. Its MCP server gives AI agents tools to take screenshots, get page information, and capture PDFs. The Free plan includes 1,000 screenshots a month with no card; paid plans start at $5 for 3,000.

FAQ

Does the IntelliJ or Eclipse plugin replace my test framework?

No. The documented workflow integrates BrowserStack SDK with an existing Java test suite. Choose the framework-specific guide for the suite you already use.

Will the plugin flow work the same for Maven and Gradle?

Do not assume so. BrowserStack’s setup details vary by framework and build tool; follow the guide matching your project.

Where should I look if a platform setting differs from my test code?

Check browserstack.yml. BrowserStack says YAML takes precedence when a capability is also set in the test script.

Is the BrowserStack Live VS Code extension the same plugin?

No. It is a separate integration for BrowserStack Live sessions. The Java SDK IDE plugin workflow covered here is for Java test suites.