From 02849ee78e648d4ae3d7e3ac9938b5d47b286aae Mon Sep 17 00:00:00 2001 From: Shirish Kamath Date: Sun, 3 Mar 2024 23:05:52 +0530 Subject: [PATCH] Updated docs for new browserstack-app-automate CLI --- docs/recipes.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 67 insertions(+), 2 deletions(-) diff --git a/docs/recipes.md b/docs/recipes.md index 05ee59f..3b5ab5e 100644 --- a/docs/recipes.md +++ b/docs/recipes.md @@ -39,7 +39,72 @@ You can also retrieve a list of active (not necessarily still running) local-ide TODO: Network proxy support for CLI. Use programmatic API if you require configuring a proxy. -## JavaScript Testing Helper +## App Automate npm Scripts for App Uploads + +Similar to the above npm scripts for BrowserStack Local, you can upload and manage your app binaries (Android apk/aab, iOS ipa/zip packages) for various frameworks supported by BrowserStack. You can later refer to these in tests using the `bs://` URIs. + +> Note that this feature needs further testing, and the CLI commands and responses may change. + + +### Flutter + +``` +browserstack-app-automate flutter list ios +browserstack-app-automate flutter upload ios +browserstack-app-automate flutter upload ios +browserstack-app-automate flutter get ios +browserstack-app-automate flutter delete ios + +browserstack-app-automate flutter list android +browserstack-app-automate flutter upload android +browserstack-app-automate flutter upload android +browserstack-app-automate flutter get android +browserstack-app-automate flutter delete android +``` + + +### Appium + +``` +browserstack-app-automate appium list +browserstack-app-automate appium upload +browserstack-app-automate appium upload +browserstack-app-automate appium get +browserstack-app-automate appium delete +``` + + +### Espresso + +``` +browserstack-app-automate espresso list +browserstack-app-automate espresso upload +browserstack-app-automate espresso upload +browserstack-app-automate espresso get +browserstack-app-automate espresso delete +``` + + +### XCUITest + +``` +browserstack-app-automate xcuitest list +browserstack-app-automate xcuitest upload +browserstack-app-automate xcuitest upload +browserstack-app-automate xcuitest get +browserstack-app-automate xcuitest delete +``` + + +### Detox Android + +``` +browserstack-app-automate detox upload app +browserstack-app-automate detox upload app-client +``` + + +## JavaScript Testing Launch Helper ```ts import { JSTestingClient } from "browserstack-client"; @@ -60,7 +125,7 @@ await browser.terminate(); ``` -## Screenshots Helper +## Screenshots Launch Helper ```ts import { ScreenshotsClient } from "browserstack-client";