Configuration

You can configure the client to change the device, OS version, currently loaded app (publicKey), and various other options.

await client.config({
    device: 'iphone11pro',
    osVersion: '15.0'
})

Additionally, you can provide these when requesting a session:

const session = await client.startSession({
    device: 'iphone11pro',
    osVersion: '15.0'
})

Configuration Options

device

string

The device to run on. See Devices & OS Versions.

osVersion

string

The operating system version on which to run your app. e.g. 11.4, 12.2, 13.3, 14.0

Note: We recommend leaving this blank so it will always use our latest default for the device

scale

number

Sets the scale of the device. Value must be between 10 and 100.

orientation

"portrait" | "horizontal"

Sets the orientation of the device

centered

"vertical" | "horizontal" | "both"

Centers the device within the embed

deviceColor

"black" | "white"

Sets the color of the device chrome

screenOnly

boolean

If true, only show the screen and not the device chrome

language

string

Sets the language of the device. Must be an ISO 639-1 & BCP 47 language code.

locale

string

(iOS only) Sets the locale of the device. Must be a locale ID e.g. en_GB, fr_FR

iosKeyboard

string

Set the language for the iOS Keyboard. eg. ja_JP@sw. See available values

disableVirtualKeyboard

boolean

(Android only) When true, disabled the onscreen keyboard

location

number[]

(iOS 12+, Android 10+) Sets location of the device in latitude and longitude. eg. [39.903924,116.391432]

timezone

string

(Android only) Sets the timezone of the device. See available values

grantPermissions

boolean

(Android only) Automatically grant all required app permissions

hidePasswords

boolean

(Android only) Hide password visibility when typing

launchUrl

string

Specify a deep link to open when your app is launched

launchArgs

string[]

(iOS only) An array of strings to pass when launching your app

debug

boolean

When true, the session will listen for debug logs and emit them as a log event.

proxy

string

Specify a proxy server to route network traffic. eg http://example.com:8080

For Appetize's built-in intercepting proxy, use intercept. Network logs are emitted from the session as a network event.

Our current support is limited to HTTP Proxies. When your app makes HTTPS connections, the data remains encrypted despite the unencrypted connection to the proxy. The app sends a CONNECT request to the proxy for the destination HTTPS server, initiating an SSL handshake. The proxy acts as a TCP connection forwarder, ensuring end-to-end encryption for app data.

record

boolean

Enables recording of all user actions that took place during the session. See UI Automation for more information.

enableAdb

boolean

(Android only) Sets up an SSH tunnel to allow ADB connections to the emulator. SSH command and info can be found by quering getAdbInfo on the session.

androidPackageManager

boolean

(Android only) Allows installation of additional APKs after app launch

appearance

"dark" | "light"

(iOS 13+ and Android 10+) Sets dark or light mode UI

params

object

A JSON object that will be passed to your app on launch

publicKey

string

The publicKey of the app that you wish to run