@browserstack/mcp-server 1.2.3 → 1.2.4

package/dist/tools/appautomate-utils/appium-sdk/languages/csharp.js

@@ -0,0 +1,78 @@
+// C# instructions and commands for App SDK utilities
+import { PLATFORM_UTILS, createStep, createEnvStep, combineInstructions, } from "../index.js";
+export function getCSharpAppInstructions() {
+    const { isWindows, isAppleSilicon, getPlatformLabel } = PLATFORM_UTILS;
+    let runCommand = "";
+    if (isWindows) {
+        runCommand = `\`\`\`cmd
+dotnet build
+dotnet test --filter <EXPRESSION> [other_args]
+\`\`\``;
+    }
+    else if (isAppleSilicon) {
+        runCommand = `\`\`\`bash
+dotnet build
+dotnet test --filter <EXPRESSION> [other_args]
+\`\`\`
+
+**Did not set the alias?**
+Use the absolute path to the dotnet installation to run your tests on Mac computers with Apple silicon chips:
+\`\`\`bash
+</absolute/path/to/location/of/dotnet/>/dotnet test
+\`\`\``;
+    }
+    else {
+        runCommand = `\`\`\`bash
+dotnet build
+dotnet test --filter <EXPRESSION> [other_args]
+\`\`\``;
+    }
+    const runStep = createStep("Run your C# test suite:", `**${getPlatformLabel()}:**
+${runCommand}
+
+**Debug Guidelines:**
+If you encounter the error: java.lang.IllegalArgumentException: Multiple entries with the same key,
+__Resolution:__
+- The app capability should only be set in one place: browserstack.yml.
+- Remove or comment out any code or configuration in your test setup (e.g., step definitions, runners, or capabilities setup) that sets the app path directly.`);
+    return runStep;
+}
+export function getCSharpSDKCommand(username, accessKey) {
+    const { isWindows = false, isAppleSilicon = false, getPlatformLabel = () => "Unknown", } = PLATFORM_UTILS || {};
+    if (!PLATFORM_UTILS) {
+        console.warn("PLATFORM_UTILS is undefined. Defaulting platform values.");
+    }
+    const envStep = createEnvStep(username, accessKey, isWindows, getPlatformLabel());
+    const installCommands = isWindows
+        ? `\`\`\`cmd
+dotnet add package BrowserStack.TestAdapter
+dotnet build
+dotnet browserstack-sdk setup --userName "${username}" --accessKey "${accessKey}"
+\`\`\``
+        : `\`\`\`bash
+dotnet add package BrowserStack.TestAdapter
+dotnet build
+dotnet browserstack-sdk setup --userName "${username}" --accessKey "${accessKey}"
+\`\`\``;
+    const installStep = createStep("Install BrowserStack SDK", `Run the following command to install the BrowserStack SDK and create a browserstack.yml file in the root directory of your project:
+
+**${getPlatformLabel()}:**
+${installCommands}`);
+    const appleSiliconNote = isAppleSilicon
+        ? createStep("[Only for Macs with Apple silicon] Install dotnet x64 on MacOS", `If you are using a Mac computer with Apple silicon chip (M1 or M2) architecture, use the given command:
+
+\`\`\`bash
+cd #(project folder Android or iOS)
+dotnet browserstack-sdk setup-dotnet --dotnet-path "<path>" --dotnet-version "<version>"
+\`\`\`
+
+- \`<path>\` - Mention the absolute path to the directory where you want to save dotnet x64
+- \`<version>\` - Mention the dotnet version which you want to use to run tests
+
+This command performs the following functions:
+- Installs dotnet x64
+- Installs the required version of dotnet x64 at an appropriate path
+- Sets alias for the dotnet installation location on confirmation (enter y option)`)
+        : "";
+    return combineInstructions(envStep, installStep, appleSiliconNote);
+}

package/dist/tools/appautomate-utils/appium-sdk/languages/java.d.ts

@@ -0,0 +1,8 @@
+export declare const MAVEN_ARCHETYPE_GROUP_ID = "com.browserstack";
+export declare const MAVEN_ARCHETYPE_ARTIFACT_ID = "junit-archetype-integrate";
+export declare const MAVEN_ARCHETYPE_VERSION = "1.0";
+export declare const JAVA_APP_FRAMEWORK_MAP: Record<string, string>;
+export declare const GRADLE_APP_SETUP_INSTRUCTIONS = "\n**For Gradle setup:**\n1. Add browserstack-java-sdk to dependencies:\n   compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'\n\n2. Add browserstackSDK path variable:\n   def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }\n\n3. Add javaagent to gradle tasks:\n   jvmArgs \"-javaagent:${browserstackSDKArtifact.file}\"\n";
+export declare function getJavaAppInstructions(): string;
+export declare function getJavaAppFrameworkForMaven(framework: string): string;
+export declare function getJavaSDKCommand(framework: string, username: string, accessKey: string, appPath?: string): string;

package/dist/tools/appautomate-utils/appium-sdk/languages/java.js

@@ -0,0 +1,87 @@
+// Java instructions and commands for App SDK utilities
+import { createStep, combineInstructions, createEnvStep, PLATFORM_UTILS, } from "../index.js";
+// Java-specific constants and mappings
+export const MAVEN_ARCHETYPE_GROUP_ID = "com.browserstack";
+export const MAVEN_ARCHETYPE_ARTIFACT_ID = "junit-archetype-integrate";
+export const MAVEN_ARCHETYPE_VERSION = "1.0";
+// Framework mapping for Java Maven archetype generation for App Automate
+export const JAVA_APP_FRAMEWORK_MAP = {
+    testng: "browserstack-sdk-archetype-integrate",
+    junit5: "browserstack-sdk-archetype-integrate",
+    selenide: "selenide-archetype-integrate",
+    jbehave: "browserstack-sdk-archetype-integrate",
+    cucumberTestng: "browserstack-sdk-archetype-integrate",
+    cucumberJunit4: "browserstack-sdk-archetype-integrate",
+    cucumberJunit5: "browserstack-sdk-archetype-integrate",
+};
+// Common Gradle setup instructions for App Automate (platform-independent)
+export const GRADLE_APP_SETUP_INSTRUCTIONS = `
+**For Gradle setup:**
+1. Add browserstack-java-sdk to dependencies:
+   compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'
+
+2. Add browserstackSDK path variable:
+   def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+
+3. Add javaagent to gradle tasks:
+   jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
+`;
+export function getJavaAppInstructions() {
+    const baseRunStep = createStep("Run your App Automate test suite:", `\`\`\`bash
+mvn test
+\`\`\``);
+    return baseRunStep;
+}
+export function getJavaAppFrameworkForMaven(framework) {
+    return JAVA_APP_FRAMEWORK_MAP[framework] || framework;
+}
+function getMavenCommandForWindows(framework, mavenFramework, username, accessKey) {
+    return (`mvn archetype:generate -B ` +
+        `-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
+        `-DarchetypeArtifactId="${mavenFramework}" ` +
+        `-DarchetypeVersion="${MAVEN_ARCHETYPE_VERSION}" ` +
+        `-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
+        `-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
+        `-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
+        `-DBROWSERSTACK_USERNAME="${username}" ` +
+        `-DBROWSERSTACK_ACCESS_KEY="${accessKey}" ` +
+        `-DBROWSERSTACK_FRAMEWORK="${framework}"`);
+}
+function getMavenCommandForUnix(framework, mavenFramework, username, accessKey) {
+    return (`mvn archetype:generate -B ` +
+        `-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
+        `-DarchetypeArtifactId="${mavenFramework}" ` +
+        `-DarchetypeVersion="${MAVEN_ARCHETYPE_VERSION}" ` +
+        `-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
+        `-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
+        `-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
+        `-DBROWSERSTACK_USERNAME="${username}" ` +
+        `-DBROWSERSTACK_ACCESS_KEY="${accessKey}" ` +
+        `-DBROWSERSTACK_FRAMEWORK="${framework}"`);
+}
+export function getJavaSDKCommand(framework, username, accessKey, appPath) {
+    const { isWindows = false, getPlatformLabel } = PLATFORM_UTILS || {};
+    const mavenFramework = getJavaAppFrameworkForMaven(framework);
+    let mavenCommand;
+    if (isWindows) {
+        mavenCommand = getMavenCommandForWindows(framework, mavenFramework, username, accessKey);
+        if (appPath) {
+            mavenCommand += ` -DBROWSERSTACK_APP="${appPath}"`;
+        }
+    }
+    else {
+        mavenCommand = getMavenCommandForUnix(framework, mavenFramework, username, accessKey);
+        if (appPath) {
+            mavenCommand += ` -DBROWSERSTACK_APP="${appPath}"`;
+        }
+    }
+    const envStep = createEnvStep(username, accessKey, isWindows, getPlatformLabel());
+    const mavenStep = createStep("Install BrowserStack SDK using Maven Archetype for App Automate", `Maven command for ${framework} (${getPlatformLabel()}):
+\`\`\`bash
+${mavenCommand}
+\`\`\`
+
+Alternative setup for Gradle users:
+${GRADLE_APP_SETUP_INSTRUCTIONS}`);
+    return combineInstructions(envStep, mavenStep);
+}

package/dist/tools/appautomate-utils/appium-sdk/languages/nodejs.d.ts

@@ -0,0 +1,3 @@
+import { AppSDKSupportedTestingFramework } from "../index.js";
+export declare function getNodejsSDKCommand(testingFramework: string, username: string, accessKey: string): string;
+export declare function getNodejsAppInstructions(testingFramework: AppSDKSupportedTestingFramework): string;

package/dist/tools/appautomate-utils/appium-sdk/languages/nodejs.js

@@ -0,0 +1,194 @@
+// Node.js instructions and commands for App SDK utilities
+import { AppSDKSupportedTestingFrameworkEnum, createStep, combineInstructions, } from "../index.js";
+export function getNodejsSDKCommand(testingFramework, username, accessKey) {
+    switch (testingFramework) {
+        case "webdriverio":
+            return getWebDriverIOCommand(username, accessKey);
+        case "nightwatch":
+            return getNightwatchCommand(username, accessKey);
+        case "jest":
+            return getJestCommand(username, accessKey);
+        case "mocha":
+            return getMochaCommand(username, accessKey);
+        case "cucumberJs":
+            return getCucumberJSCommand(username, accessKey);
+        default:
+            return "";
+    }
+}
+export function getNodejsAppInstructions(testingFramework) {
+    switch (testingFramework) {
+        case AppSDKSupportedTestingFrameworkEnum.webdriverio:
+            return createStep("Run your WebdriverIO test suite:", "Your test suite is now ready to run on BrowserStack. Use the commands defined in your package.json file to run the tests");
+        case AppSDKSupportedTestingFrameworkEnum.nightwatch:
+            return createStep("Run your App Automate test suite:", `For Android:
+          \`\`\`bash
+            npx nightwatch <path to tests> --env browserstack.android 
+          \`\`\`
+          For iOS:
+          \`\`\`bash
+            npx nightwatch <path to tests> --env browserstack.ios
+          \`\`\``);
+        case AppSDKSupportedTestingFrameworkEnum.jest:
+            return createStep("Run your Jest test suite with BrowserStack SDK:", `Use the npm script defined in your package.json. For example:\n\n\`\`\`bash\nnpx run browserstack-node-sdk jest specs/single_test.js\n\`\`\``);
+        case AppSDKSupportedTestingFrameworkEnum.mocha:
+            return createStep("Run your Mocha test suite with BrowserStack SDK:", `Use the npm script defined in your package.json. For example:\n\n\`\`\`bash\nnpx run browserstack-node-sdk mocha specs/single_test.js\n\`\`\``);
+        case AppSDKSupportedTestingFrameworkEnum.cucumberJs:
+            return createStep("Run your Cucumber JS test suite with BrowserStack SDK:", `Use the npm script defined in your package.json. For example:\n\n\`\`\`bash\nnpx run browserstack-node-sdk cucumber-js specs/single_test.js\n\`\`\``);
+        default:
+            return "";
+    }
+}
+function getWebDriverIOCommand(username, accessKey) {
+    const prerequisiteStep = createStep("Prerequisite Setup:", `a. Ensure you do not modify or replace any existing local driver code, 
+    as it will be automatically managed and overwritten by the BrowserStack SDK/Driver.
+    b. Do not create any YML file in this integration as it is not required.
+    c. Ensure you create the WDIO config file as per the instructions below.`);
+    const envStep = createStep("Set your BrowserStack credentials as environment variables:", `\`\`\`bash
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\``);
+    const installStep = createStep("Install BrowserStack WDIO service:", `\`\`\`bash
+npm install @wdio/browserstack-service@^7 --save-dev
+\`\`\``);
+    const configStep = createStep("Update your WebdriverIO config file (e.g., \\`wdio.conf.js\\`) to add the BrowserStack service and capabilities:", `\`\`\`js
+exports.config = {
+  user: process.env.BROWSERSTACK_USERNAME || '${username}',
+  key: process.env.BROWSERSTACK_ACCESS_KEY || '${accessKey}',
+  hostname: 'hub.browserstack.com',
+  services: [
+    [
+      'browserstack',
+      {
+        app: 'bs://sample.app',
+        browserstackLocal: true,
+        accessibility: false,
+        testObservabilityOptions: {
+          buildName: "bstack-demo",
+          projectName: "BrowserStack Sample",
+          buildTag: 'Any build tag goes here. For e.g. ["Tag1","Tag2"]'
+        },
+      },
+    ]
+  ],
+  capabilities: [{
+    'bstack:options': {
+      deviceName: 'Samsung Galaxy S22 Ultra',
+      platformVersion: '12.0',
+      platformName: 'android',
+    }
+  }],
+  commonCapabilities: {
+    'bstack:options': {
+      debug: true,
+      networkLogs: true,
+      percy: false,
+      percyCaptureMode: 'auto'
+    }
+  },
+  maxInstances: 10,
+  // ...other config
+};
+\`\`\``);
+    return combineInstructions(prerequisiteStep, envStep, installStep, configStep);
+}
+function getNightwatchCommand(username, accessKey) {
+    const prerequisiteStep = createStep("Prerequisite Setup:", ` a. Ensure you do not modify or replace any existing local driver code, 
+      as it will be automatically managed and overwritten by the BrowserStack SDK/Driver.
+      b. Do not create any YML file in this integration as it is not required.
+      c. Ensure you create the WDIO config file as per the instructions below.`);
+    const envStep = createStep("Set your BrowserStack credentials as environment variables:", `\`\`\`bash 
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\``);
+    const installStep = createStep("Install Nightwatch and BrowserStack integration:", `\`\`\`bash
+npm install --save-dev @nightwatch/browserstack
+\`\`\``);
+    const configStep = createStep("Update your Nightwatch config file (e.g., \\`nightwatch.conf.js\\`) to add the BrowserStack settings and capabilities:", `\`\`\`js
+
+    test_settings:{
+    ...
+    browserstack: {
+      selenium: {
+        host: 'hub.browserstack.com',
+        port: 443
+      },
+      desiredCapabilities: {
+       'bstack:options': {
+          userName: '',
+          accessKey: '',
+          appiumVersion: '2.0.0'
+        }
+      },
+      disable_error_log: false,
+      webdriver: {
+        timeout_options: {
+          timeout: 60000,
+          retry_attempts: 3
+        },
+        keep_alive: true,
+        start_process: false
+      }
+    },
+    'browserstack.android': {
+      extends: 'browserstack',
+      'desiredCapabilities': {
+        browserName: null,
+        'appium:options': {
+          automationName: 'UiAutomator2',
+          app: 'wikipedia-sample-app',// custom-id of the uploaded app
+          appPackage: 'org.wikipedia',
+          appActivity: 'org.wikipedia.main.MainActivity',
+          appWaitActivity: 'org.wikipedia.onboarding.InitialOnboardingActivity',
+          platformVersion: '11.0',
+          deviceName: 'Google Pixel 5'
+        },
+        appUploadUrl: 'https://raw.githubusercontent.com/priyansh3133/wikipedia/main/wikipedia.apk',// URL of the app to be uploaded to BrowserStack before starting the test
+        // appUploadPath: '/path/to/app_name.apk' // if the app needs to be uploaded to BrowserStack from a local system
+      }
+    },
+    'browserstack.ios': {
+      extends: 'browserstack',
+      'desiredCapabilities': {
+        browserName: null,
+        platformName: 'ios',
+        'appium:options': {
+          automationName: 'XCUITest',
+          app: 'BStackSampleApp',
+          platformVersion: '16',
+          deviceName: 'iPhone 14'
+        },
+        appUploadUrl: 'https://www.browserstack.com/app-automate/sample-apps/ios/BStackSampleApp.ipa',
+        // appUploadPath: '/path/to/app_name.ipa'
+      }
+    ...
+  }
+\`\`\``);
+    return combineInstructions(prerequisiteStep, envStep, installStep, configStep);
+}
+function getJestCommand(username, accessKey) {
+    const envStep = createStep("Set your BrowserStack credentials as environment variables:", `\`\`\`bash
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\``);
+    const installStep = createStep("Install Jest and BrowserStack SDK:", `\`\`\`bash
+npm install --save-dev browserstack-node-sdk
+\`\`\``);
+    return combineInstructions(envStep, installStep);
+}
+function getMochaCommand(username, accessKey) {
+    const envStep = createStep("Set your BrowserStack credentials as environment variables:", `\`\`\`bash
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\``);
+    const installStep = createStep("Install Mocha and BrowserStack SDK:", `\`\`\`bash
+npm install --save-dev browserstack-node-sdk
+\`\`\``);
+    return combineInstructions(envStep, installStep);
+}
+function getCucumberJSCommand(username, accessKey) {
+    return createStep("Set your BrowserStack credentials as environment variables:", `\`\`\`bash
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\``);
+}

package/dist/tools/appautomate-utils/appium-sdk/languages/python.d.ts

@@ -0,0 +1,3 @@
+import { AppSDKSupportedTestingFramework } from "../index.js";
+export declare function getPythonAppInstructions(testingFramework: AppSDKSupportedTestingFramework): string;
+export declare function getPythonSDKCommand(framework: string, username: string, accessKey: string): string;

package/dist/tools/appautomate-utils/appium-sdk/languages/python.js

@@ -0,0 +1,76 @@
+// Python instructions and commands for App SDK utilities
+import { AppSDKSupportedTestingFrameworkEnum, createStep, createEnvStep, combineInstructions, PLATFORM_UTILS, } from "../index.js";
+export function getPythonAppInstructions(testingFramework) {
+    switch (testingFramework) {
+        case AppSDKSupportedTestingFrameworkEnum.robot:
+            return createStep("Run your App Automate test suite with Robot Framework:", `\`\`\`bash
+browserstack-sdk robot <path-to-test-files>
+\`\`\``);
+        case AppSDKSupportedTestingFrameworkEnum.pytest:
+            return createStep("Run your App Automate test suite with Pytest:", `\`\`\`bash
+browserstack-sdk pytest -s <file-name.py>
+\`\`\``);
+        case AppSDKSupportedTestingFrameworkEnum.behave:
+            return createStep("Run your App Automate test suite with Behave:", `\`\`\`bash
+browserstack-sdk behave <path-to-test-files>
+\`\`\``);
+        case AppSDKSupportedTestingFrameworkEnum.lettuce:
+            return createStep("Run your test with Lettuce:", `\`\`\`bash
+# Run using paver
+paver run first_test
+\`\`\``);
+        default:
+            return "";
+    }
+}
+export function getPythonSDKCommand(framework, username, accessKey) {
+    const { isWindows, getPlatformLabel } = PLATFORM_UTILS;
+    switch (framework) {
+        case "robot":
+        case "pytest":
+        case "behave":
+            return getPythonCommonSDKCommand(username, accessKey, isWindows, getPlatformLabel());
+        case "lettuce":
+            return getLettuceCommand(username, accessKey, isWindows, getPlatformLabel());
+        default:
+            return "";
+    }
+}
+function getPythonCommonSDKCommand(username, accessKey, isWindows, platformLabel) {
+    const envStep = createEnvStep(username, accessKey, isWindows, platformLabel, "Set your BrowserStack credentials as environment variables:");
+    const installStep = createStep("Install BrowserStack Python SDK:", `\`\`\`bash
+python3 -m pip install browserstack-sdk
+\`\`\``);
+    const setupStep = createStep("Set up BrowserStack SDK:", `\`\`\`bash
+browserstack-sdk setup --username "${username}" --key "${accessKey}"
+\`\`\``);
+    return combineInstructions(envStep, installStep, setupStep);
+}
+function getLettuceCommand(username, accessKey, isWindows, platformLabel) {
+    const envStep = createEnvStep(username, accessKey, isWindows, platformLabel, "Set your BrowserStack credentials as environment variables:");
+    const configStep = createStep("Configure Appium's desired capabilities in config.json:", `**Android example:**
+\`\`\`json
+{
+    "capabilities": {
+      "browserstack.user" : "${username}",
+      "browserstack.key" : "${accessKey}",
+      "project": "First Lettuce Android Project",
+      "build": "Lettuce Android",
+      "name": "first_test",
+      "browserstack.debug": true,
+      "app": "bs://<app-id>",
+      "device": "Google Pixel 3",
+      "os_version": "9.0"
+    }
+}
+\`\`\``);
+    const initStep = createStep("Initialize remote WebDriver in terrain.py:", `\`\`\`python
+# Initialize the remote Webdriver using BrowserStack remote URL
+# and desired capabilities defined above
+context.browser = webdriver.Remote(
+    desired_capabilities=desired_capabilities,
+    command_executor="https://hub-cloud.browserstack.com/wd/hub"
+)
+\`\`\``);
+    return combineInstructions(envStep, configStep, initStep);
+}

package/dist/tools/appautomate-utils/appium-sdk/languages/ruby.d.ts

@@ -0,0 +1,2 @@
+export declare function getRubyAppInstructions(): string;
+export declare function getRubySDKCommand(framework: string, username: string, accessKey: string): string;

package/dist/tools/appautomate-utils/appium-sdk/languages/ruby.js

@@ -0,0 +1,85 @@
+// Ruby instructions and commands for App SDK utilities
+import { createStep, combineInstructions, createEnvStep, PLATFORM_UTILS, } from "../index.js";
+const username = "${process.env.BROWSERSTACK_USERNAME}";
+const accessKey = "${process.env.BROWSERSTACK_ACCESS_KEY}";
+export function getRubyAppInstructions() {
+    const configStep = createStep("Create/Update the config file (config.yml) as follows:", `\`\`\`yaml
+server: "hub-cloud.browserstack.com"
+
+common_caps:
+  "browserstack.user": "${username}"
+  "browserstack.key": "${accessKey}"
+  "project": "First Cucumber Android Project"
+  "build": "Cucumber Android"
+  "browserstack.debug": true
+
+browser_caps:
+  -
+    "deviceName": "Google Pixel 3"
+    "os_version": "9.0"
+    "app": "<replace with the APK path from the upload step>"
+    "name": "first_test"
+\`\`\``);
+    const envStep = createStep("Create/Update your support/env.rb file:", `\`\`\`ruby
+require 'rubygems'
+require 'appium_lib'
+
+# Load configuration from config.yml
+caps = Appium.load_appium_txt file: File.expand_path('./../config.yml', __FILE__)
+username = "${username}"
+password = "${accessKey}"
+
+# Create desired capabilities
+desired_caps = {
+  caps: caps,
+  appium_lib: {
+    server_url: "https://#{username}:#{password}@#{caps['server']}/wd/hub"
+  }
+}
+
+# Initialize Appium driver
+begin
+  $appium_driver = Appium::Driver.new(desired_caps, true)
+  $driver = $appium_driver.start_driver
+rescue Exception => e
+  puts e.message
+  Process.exit(0)
+end
+
+# Add cleanup hook
+at_exit do
+  $driver.quit if $driver
+end
+\`\`\``);
+    const runStep = createStep("Run the test:", `\`\`\`bash
+bundle exec cucumber
+\`\`\``);
+    return combineInstructions(configStep, envStep, runStep);
+}
+export function getRubySDKCommand(framework, username, accessKey) {
+    const { isWindows, getPlatformLabel } = PLATFORM_UTILS;
+    const envStep = createEnvStep(username, accessKey, isWindows, getPlatformLabel(), "Set your BrowserStack credentials as environment variables:");
+    const installStep = createStep("Install required Ruby gems:", `\`\`\`bash
+# Install Bundler if not already installed
+gem install bundler
+
+# Install Appium Ruby client library
+gem install appium_lib
+
+# Install Cucumber
+gem install cucumber
+\`\`\``);
+    const gemfileStep = createStep("Create a Gemfile for dependency management:", `\`\`\`ruby
+# Gemfile
+source 'https://rubygems.org'
+
+gem 'appium_lib'
+gem 'cucumber'
+\`\`\`
+
+Then run:
+\`\`\`bash
+bundle install
+\`\`\``);
+    return combineInstructions(envStep, installStep, gemfileStep);
+}

package/dist/tools/appautomate-utils/appium-sdk/types.d.ts

@@ -0,0 +1,57 @@
+export declare enum AppSDKSupportedLanguageEnum {
+    java = "java",
+    nodejs = "nodejs",
+    python = "python",
+    ruby = "ruby",
+    csharp = "csharp"
+}
+export type AppSDKSupportedLanguage = keyof typeof AppSDKSupportedLanguageEnum;
+export declare enum AppSDKSupportedFrameworkEnum {
+    appium = "appium"
+}
+export type AppSDKSupportedFramework = keyof typeof AppSDKSupportedFrameworkEnum;
+export declare enum AppSDKSupportedTestingFrameworkEnum {
+    testng = "testng",
+    junit5 = "junit5",
+    junit4 = "junit4",
+    selenide = "selenide",
+    jbehave = "jbehave",
+    cucumberTestng = "cucumberTestng",
+    cucumberJunit4 = "cucumberJunit4",
+    cucumberJunit5 = "cucumberJunit5",
+    webdriverio = "webdriverio",
+    nightwatch = "nightwatch",
+    jest = "jest",
+    mocha = "mocha",
+    cucumberJs = "cucumberJs",
+    robot = "robot",
+    pytest = "pytest",
+    behave = "behave",
+    lettuce = "lettuce",
+    rspec = "rspec",
+    cucumberRuby = "cucumberRuby",
+    nunit = "nunit",
+    mstest = "mstest",
+    xunit = "xunit",
+    specflow = "specflow",
+    reqnroll = "reqnroll"
+}
+export type AppSDKSupportedTestingFramework = keyof typeof AppSDKSupportedTestingFrameworkEnum;
+export declare enum AppSDKSupportedPlatformEnum {
+    android = "android",
+    ios = "ios"
+}
+export type AppSDKSupportedPlatform = keyof typeof AppSDKSupportedPlatformEnum;
+export interface AppSDKInstruction {
+    content: string;
+    type: "config" | "run" | "setup";
+}
+export declare const SUPPORTED_CONFIGURATIONS: {
+    appium: {
+        ruby: string[];
+        java: never[];
+        csharp: never[];
+        python: string[];
+        nodejs: string[];
+    };
+};

package/dist/tools/appautomate-utils/appium-sdk/types.js

@@ -0,0 +1,54 @@
+// Shared types for App SDK utilities
+export var AppSDKSupportedLanguageEnum;
+(function (AppSDKSupportedLanguageEnum) {
+    AppSDKSupportedLanguageEnum["java"] = "java";
+    AppSDKSupportedLanguageEnum["nodejs"] = "nodejs";
+    AppSDKSupportedLanguageEnum["python"] = "python";
+    AppSDKSupportedLanguageEnum["ruby"] = "ruby";
+    AppSDKSupportedLanguageEnum["csharp"] = "csharp";
+})(AppSDKSupportedLanguageEnum || (AppSDKSupportedLanguageEnum = {}));
+export var AppSDKSupportedFrameworkEnum;
+(function (AppSDKSupportedFrameworkEnum) {
+    AppSDKSupportedFrameworkEnum["appium"] = "appium";
+})(AppSDKSupportedFrameworkEnum || (AppSDKSupportedFrameworkEnum = {}));
+export var AppSDKSupportedTestingFrameworkEnum;
+(function (AppSDKSupportedTestingFrameworkEnum) {
+    AppSDKSupportedTestingFrameworkEnum["testng"] = "testng";
+    AppSDKSupportedTestingFrameworkEnum["junit5"] = "junit5";
+    AppSDKSupportedTestingFrameworkEnum["junit4"] = "junit4";
+    AppSDKSupportedTestingFrameworkEnum["selenide"] = "selenide";
+    AppSDKSupportedTestingFrameworkEnum["jbehave"] = "jbehave";
+    AppSDKSupportedTestingFrameworkEnum["cucumberTestng"] = "cucumberTestng";
+    AppSDKSupportedTestingFrameworkEnum["cucumberJunit4"] = "cucumberJunit4";
+    AppSDKSupportedTestingFrameworkEnum["cucumberJunit5"] = "cucumberJunit5";
+    AppSDKSupportedTestingFrameworkEnum["webdriverio"] = "webdriverio";
+    AppSDKSupportedTestingFrameworkEnum["nightwatch"] = "nightwatch";
+    AppSDKSupportedTestingFrameworkEnum["jest"] = "jest";
+    AppSDKSupportedTestingFrameworkEnum["mocha"] = "mocha";
+    AppSDKSupportedTestingFrameworkEnum["cucumberJs"] = "cucumberJs";
+    AppSDKSupportedTestingFrameworkEnum["robot"] = "robot";
+    AppSDKSupportedTestingFrameworkEnum["pytest"] = "pytest";
+    AppSDKSupportedTestingFrameworkEnum["behave"] = "behave";
+    AppSDKSupportedTestingFrameworkEnum["lettuce"] = "lettuce";
+    AppSDKSupportedTestingFrameworkEnum["rspec"] = "rspec";
+    AppSDKSupportedTestingFrameworkEnum["cucumberRuby"] = "cucumberRuby";
+    AppSDKSupportedTestingFrameworkEnum["nunit"] = "nunit";
+    AppSDKSupportedTestingFrameworkEnum["mstest"] = "mstest";
+    AppSDKSupportedTestingFrameworkEnum["xunit"] = "xunit";
+    AppSDKSupportedTestingFrameworkEnum["specflow"] = "specflow";
+    AppSDKSupportedTestingFrameworkEnum["reqnroll"] = "reqnroll";
+})(AppSDKSupportedTestingFrameworkEnum || (AppSDKSupportedTestingFrameworkEnum = {}));
+export var AppSDKSupportedPlatformEnum;
+(function (AppSDKSupportedPlatformEnum) {
+    AppSDKSupportedPlatformEnum["android"] = "android";
+    AppSDKSupportedPlatformEnum["ios"] = "ios";
+})(AppSDKSupportedPlatformEnum || (AppSDKSupportedPlatformEnum = {}));
+export const SUPPORTED_CONFIGURATIONS = {
+    appium: {
+        ruby: ["cucumberRuby"],
+        java: [],
+        csharp: [],
+        python: ["pytest", "robot", "behave", "lettuce"],
+        nodejs: ["jest", "mocha", "cucumberJs", "webdriverio", "nightwatch"],
+    },
+};