Files
appium/docs/server-args.md
2013-03-28 16:28:31 -07:00

2.7 KiB

Appium server arguments

Usage: node server.js [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
-V, --verbose false Get verbose logging output
-U, --udid null (IOS-only) 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
-k, --keep-artifacts false (IOS-only) Keep Instruments trace directories
--fast-reset false (Android-only) Reset app state using clean.apk
--no-reset false Reset app state after each session (IOS: delete plist; Android: install app before session and uninstall after 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
-G, --webhook null Also send log output to this HTTP listener --webhook localhost:9876
-w, --warp false (IOS-only) IOS has a weird built-in unavoidable sleep. One way around this is to speed up the system clock. Use this time warp hack to speed up test execution (WARNING, actually alters clock, could be bad news bears!)
--without-delay false (IOS-only) IOS has a weird built-in unavoidable delay. One way around this is to run instruments with a library loaded to patch it so that it skips the delay. Use this flag to speed up test execution.
--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 MainActivity (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
--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
--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
--orientation null (IOS-only) use LANDSCAPE or PORTRAIT to initialize all requests to this orientation --orientation LANDSCAPE