Setup

The MobileBoost SDK for Appium is available in Java, Python, and TypeScript. Choose your language below.

Prerequisites

Install Appium and the platform drivers:

# Install Appium
npm install -g appium

# Install drivers
appium driver install xcuitest    # iOS
appium driver install uiautomator2  # Android

Installation

Java
Python
TypeScript

Add the dependency to your pom.xml:

<dependencies>
    <dependency>
        <groupId>io.mobileboost.gptdriver</groupId>
        <artifactId>gptdriver-client</artifactId>
        <version>2.2.0</version>
    </dependency>
</dependencies>

pip install gptdriver-client

To upgrade to the latest version:

pip install --upgrade gptdriver-client

npm install mobileboost-cli

Configuration

Java
Python
TypeScript

Replace your Appium driver classes with the MobileBoost subclasses and add your API key as a capability:

import io.mobileboost.gptdriver.*;

UiAutomator2Options options = new UiAutomator2Options();
options.setCapability("gptdriver:apiKey", "YOUR_API_KEY");

// Use GptDriverAndroid instead of AndroidDriver
AndroidDriver driver = new GptDriverAndroid(
    new java.net.URL("http://127.0.0.1:4723"),
    options
);

You can also pass additional context to enhance AI behavior:

GptDriverAndroid driver = new GptDriverAndroid(
    new java.net.URL("http://127.0.0.1:4723"),
    options,
    "When asked about Location Permissions, grant it."
);

Create a GptDriver instance with your API key:

from gptdriver_client import GptDriver

gptd = GptDriver(
    api_key="YOUR_API_KEY",
    platform="android",
    device_name="Pixel 7",
    platform_version="15.0",
)

Or pass an existing Appium driver:

from gptdriver_client import GptDriver
from appium import webdriver

driver = webdriver.Remote(
    command_executor="http://127.0.0.1:4723",
    options=options
)

gptd = GptDriver(
    api_key="YOUR_API_KEY",
    driver=driver
)

Initialize the CLI in your project:

mobileboost init

Then launch the studio to start creating tests:

mobileboost studio

Start the Appium server

Before running tests, start the Appium server:

appium

Local tooling

Agent skill

SDK

Prerequisites

Installation

Configuration

Start the Appium server

Local tooling

Agent skill

SDK

​Prerequisites

​Installation

​Configuration

​Start the Appium server

Prerequisites

Installation

Configuration

Start the Appium server