mirror of
https://github.com/appium/appium.git
synced 2026-01-25 11:48:49 -06:00
4a1cc2580c
This commit constitutes a pretty big refactor of the instruments process handler. It also introduces a server flag, '--backend-retries', with a default of '3', which specifies how many times Appium will retry launching instruments before giving up and saying that it crashed or timed out. This works in concert with launchTimeout, of course. I think this refactor also fixes some longstanding callback reasoning errors and maybe some other bugs. It might also introduce some bugs of its own though :-)
4.5 KiB
4.5 KiB
Appium server arguments
Usage: node . [flags]
Server flags
All flags are optional, but some are required in conjunction with certain others.
| Flag | Default | Description | Example |
|---|---|---|---|
--app |
null | IOS: abs path to simulator-compiled .app file or the bundle_id of the desired target on device; Android: abs path to .apk file | --app /abs/path/to/my.app |
--ipa |
null | (IOS-only) abs path to compiled .ipa file | --ipa /abs/path/to/my.ipa |
-q, --quiet |
false | Don't use verbose logging output | |
-U, --udid |
null | Unique device identifier of the connected physical device | --udid 1adsf-sdfas-asdf-123sdf |
-a, --address |
0.0.0.0 | IP Address to listen on | --address 0.0.0.0 |
-p, --port |
4723 | port to listen on | --port 4723 |
-dp, --device-port |
4724 | (Android-only) port to connect to device on | --device-port 4724 |
-k, --keep-artifacts |
false | (IOS-only) Keep Instruments trace directories | |
-r, --backend-retries |
3 | (iOS-only) How many times to retry launching Instruments before saying it crashed or timed out | --backend-retries 3 |
--session-override |
false | Enables session override (clobbering) | |
--full-reset |
false | (Android-only) Reset app state by uninstalling app instead of clearing app data | |
--no-reset |
false | Don't reset app state between sessions (IOS: don't delete app plist files; Android: don't uninstall app before new session) | |
-l, --pre-launch |
false | Pre-launch the application before allowing the first session (Requires --app and, for Android, --app-pkg and --app-activity) | |
-g, --log |
null | Log output to this file instead of stdout | --log /path/to/appium.log |
--log-timestamp |
false | Show timestamps in console output | |
--log-no-colors |
false | Don't use colors in console output | |
-G, --webhook |
null | Also send log output to this HTTP listener | --webhook localhost:9876 |
--native-instruments-lib |
false | (IOS-only) IOS has a weird built-in unavoidable delay. We patch this in appium. If you do not want it patched, pass in this flag. | |
--merciful, -m |
false | Don't run the watcher process that will force-kill an unresponsive instruments | |
--app-pkg |
null | (Android-only) Java package of the Android app you want to run (e.g., com.example.android.myApp) | --app-pkg com.example.android.myApp |
--app-activity |
null | (Android-only) Activity name for the Android activity you want to launch from your package (e.g., MainActivity) | --app-activity MainActivity |
--app-wait-activity |
false | (Android-only) Activity name for the Android activity you want to wait for (e.g., SplashActivity) | --app-wait-activity SplashActivity |
--avd |
null | name of the avd to launch | --avd @default |
--device-ready-timeout |
5 | (Android-only) Timeout in seconds while waiting for device to become ready | --device-ready-timeout 5 |
--safari |
false | (IOS-Only) Use the safari app | |
--device-name |
null | (IOS-Simulator-only) name of the iOS device to use | --device-name iPhone Retina (4-inch) |
--default-device |
false | (IOS-Simulator-only) use the default simulator that instruments launches on its own | |
--force-iphone |
false | (IOS-only) Use the iPhone Simulator no matter what the app wants | |
--force-ipad |
false | (IOS-only) Use the iPad Simulator no matter what the app wants | |
--language |
null | (IOS-only) language for the iOS simulator | --language en |
--locale |
null | (IOS-only) locale for the iOS simulator | --locale en_US |
--calendar-format |
null | (IOS-only) calendar format for the iOS simulator | --calendar-format gregorian |
--orientation |
null | (IOS-only) use LANDSCAPE or PORTRAIT to initialize all requests to this orientation | --orientation LANDSCAPE |
--tracetemplate |
null | (IOS-only) .tracetemplate file to use with Instruments | --tracetemplate /Users/me/Automation.tracetemplate |
--nodeconfig |
null | Configuration JSON file to register appium with selenium grid | --nodeconfig /abs/path/to/nodeconfig.json |
-ra, --robot-address |
0.0.0.0 | IP Address of robot | --robot-address 0.0.0.0 |
-rp, --robot-port |
-1 | port for robot | --robot-port 4242 |
--selendroid-port |
8080 | Local port used for communication with Selendroid | --selendroid-port 8080 |
--use-keystore |
false | (Android-only) When set the keystore will be used to sign apks. | |
--keystore-path |
/Users/jlipps/.android/debug.keystore | (Android-only) Path to keystore | |
--keystore-password |
android | (Android-only) Password to keystore | |
--key-alias |
androiddebugkey | (Android-only) Key alias | |
--key-password |
android | (Android-only) Key password | |
--show-config |
false | Show info about the appium server configuration and exit |