Expose mobile: shell documentation (#2655)

* Expose mobile: shell documentation * Update test-configuration-options.md * Update test-configuration-options.md * Fix args for mobile:shell --------- Co-authored-by: kristofmuhi <[email protected]>
saucelabs · Mar 4, 2024 · 8acdbb2 · 8acdbb2
1 parent da15cd2
commit 8acdbb2
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md
@@ -1523,6 +1523,26 @@ capabilities.setCapability("sauce:options", sauceOptions);
 
 ---
 
+### `mobile: shell`
+
+<p><small>| OPTIONAL | STRING | <span className="sauceGreen">Real Devices Only</span> | <span className="sauceGreen">BETA</span> |</small></p>
+
+Execute ADB shell commands, through Appium's `mobile: shell` capability.
+
+:::note
+Sauce Labs now supports ADB commands for Appium. To use ADB and `mobile: shell` commands, please [sign up for our BETA through this form](https://forms.gle/42qv8U1RukqC62x86) and indicate the desired ADB commands you would like to run. We will be supporting a limited list of ADB commands through `mobile: shell`.
+:::
+
+
+```java
+driver.executeScript("mobile: shell", ImmutableMap.of(
+    "command", "input",
+    "args", ImmutableList.of("keyevent", "3")
+));
+```
+
+---
+
 ## Desktop and Mobile Capabilities: Sauce-Specific – Optional
 
 Optional Sauce Labs-specific capabilities that you can use for any Sauce Labs test. They must be added to the `sauce:options` block of your session creation code.