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.
platformenumобязательный
Session platform type
browserenum
Browser to launch (required for browser platform)
browserVersionstring
Browser version (cloud providers only, default: latest)
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.
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)
reportingobject
Cloud provider reporting labels (project, build, session)
headlessboolean
Run browser in headless mode (default: true)
windowWidthnumber
Browser window width
windowHeightnumber
Browser window height
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.
platformVersionstring
OS version for mobile sessions (e.g., "17.0", "14"). Mobile (ios/android) only.
appPathstring
Path to app file (.app/.apk/.ipa)
automationNameenum
Automation driver
autoGrantPermissionsboolean
Auto-grant app permissions (default: true)
autoAcceptAlertsboolean
Auto-accept alerts (default: true)
autoDismissAlertsboolean
Auto-dismiss alerts (default: false)
appWaitActivitystring
Activity to wait for on Android launch
udidstring
Unique Device Identifier for iOS real device
noResetboolean
Preserve app data between sessions
fullResetboolean
Uninstall app before/after session
newCommandTimeoutnumber
Appium command timeout in seconds
traceboolean
Enable trace recording — produces a Playwright-compatible zip saved to .trace/ on close_session, playable at player.vibium.dev.
attachboolean
Attach to existing Chrome instead of launching
attachConfigobject
Chrome remote debugging connection (attach mode only, defaults: port 9222, host localhost)
webdriverConfigobject
Existing W3C WebDriver endpoint connection (provider: "external" only). Defaults to 127.0.0.1:4445/.
appiumConfigobject
Appium server connection (local provider only)
regionenum
Sauce Labs region (default: eu-central-1). Only used with provider: "saucelabs".
tunnelany
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.
browserstackLocalany
Deprecated: use "tunnel" instead. Enable BrowserStack Local tunnel routing.
saucelabsLocalany
Deprecated: use "tunnel" instead. Enable Sauce Connect tunnel routing.
testmuLocalany
Deprecated: use "tunnel" instead. Enable TestMu Tunnel routing.
navigationUrlstring
URL to navigate to after starting
capabilitiesobject
Additional capabilities to merge