appstring
App URL (bs://... for BrowserStack, storage:filename= for Sauce Labs, lt://... for TestMu, tb://... for TestingBot, cloud:<package-or-bundle> for Digital.ai mobile sessions)
appiumConfigobject
Appium server connection (local provider only)
appPathstring
Path to app file (.app/.apk/.ipa)
appWaitActivitystring
Activity to wait for on Android launch
attachboolean
Attach to existing Chrome instead of launching
attachConfigobject
Chrome remote debugging connection (attach mode only, defaults: port 9222, host localhost)
autoAcceptAlertsboolean
Auto-accept alerts (default: true)
autoDismissAlertsboolean
Auto-dismiss alerts (default: false)
autoGrantPermissionsboolean
Auto-grant app permissions (default: true)
automationNameenum
Automation driver
browserenum
Browser to launch (required for browser platform)
browserstackLocalstring | boolean
Deprecated: use "tunnel" instead. Enable BrowserStack Local tunnel routing.
browserVersionstring
Browser version (cloud providers only, default: latest)
capabilitiesobject
Additional capabilities to merge
deviceNamestring
Mobile device/emulator/simulator name (required for ios/android)
deviceQuerystring
Digital.ai device selection query for dynamic allocation, e.g. "@os='android' and @version='14' and @name='.Pixel.'". Only used with provider: "digitalai" mobile sessions; if omitted, one is built from deviceName/platformVersion.
fullResetboolean
Uninstall app before/after session
headlessboolean
Run browser in headless mode (default: true)
navigationUrlstring
URL to navigate to after starting
newCommandTimeoutnumber
Appium command timeout in seconds
noResetboolean
Preserve app data between sessions
osstring
Operating system for cloud provider browser sessions (e.g. "Windows", "Mac", "macOS", "Linux"). BrowserStack: sets bstack:options.os separately. TestMu/Sauce Labs/TestingBot: combined with osVersion into W3C platformName. Digital.ai: combined with osVersion into the digitalai:osName capability (e.g. "Mac OS Sequoia", "Windows 10") — required for the grid to match a node. Browser platform only.
osVersionstring
OS version for cloud provider browser sessions (e.g. "11", "15", "Monterey"). BrowserStack: sets bstack:options.osVersion separately. TestMu/Sauce Labs/TestingBot: combined with os into W3C platformName. Digital.ai: combined with os into digitalai:osName. Browser platform only.
platformenumобязательный
Session platform type
platformVersionstring
OS version for mobile sessions (e.g., "17.0", "14"). Mobile (ios/android) only.
providerenum
Session provider (default: local). Use "external" to connect to an externally managed W3C WebDriver endpoint. "digitalai" requires DIGITALAI_CLOUD_URL + DIGITALAI_ACCESS_KEY env vars.
regionenum
Sauce Labs region (default: eu-central-1). Only used with provider: "saucelabs".
reportingobject
Cloud provider reporting labels (project, build, session)
saucelabsLocalstring | boolean
Deprecated: use "tunnel" instead. Enable Sauce Connect tunnel routing.
testmuLocalstring | boolean
Deprecated: use "tunnel" instead. Enable TestMu Tunnel routing.
traceboolean
Enable trace recording — produces a Playwright-compatible zip saved to .trace/ on close_session, playable at player.vibium.dev.
tunnelstring | boolean
Enable local tunnel routing (cloud providers only, default: false). true = auto-start tunnel before session and stop on close. "external" = tunnel already running externally.
tunnelNamestring
Tunnel identifier name. With tunnel: "external" this must match the running tunnel. With tunnel: true a unique name is auto-generated if not provided.
udidstring
Unique Device Identifier for iOS real device
webdriverConfigobject
Existing W3C WebDriver endpoint connection (provider: "external" only). Defaults to 127.0.0.1:4445/.
windowHeightnumber
Browser window height
windowWidthnumber
Browser window width