Appium Service Command-line arguments

Appium can be started directly from the command line and also supports command line parameter configuration

Reference:

http://appium.io/slate/cn/master/

How to use

For example:

Appium--shell

Server flag

All the flags are optional, but there are some flags that need to be grouped together to take effect.

logo	Default Value	Description	Example
--shell	Null	Enter REPL mode
--localizable-strings-dir	En.lproj	IOS only: Locate the relative path to the directory where the strings resides.	--localizable-strings-dir en.lproj
--app	Null	IOS: The absolute path of the app based on the emulator compiler or the bundle_id of the device target; the absolute path to the android:apk file--app /abs/path/to/my.app
--ipa	Null	(ios-only). An absolute path to an IPA file	--ipa /abs/path/to/my.ipa
-U,--udid	Null	Unique device identifiers for connecting physical devices	--udid 1adsf-sdfas-asdf-123sdf
-a,--address	0.0.0.0	IP address of the listener	--address 0.0.0.0
-p,--port	4723	Ports to listen on	--port 4723
-ca,--callback-address	Null	Callback IP address (default: same IP address)	--callback-address 127.0.0.1
-cp,--callback-port	Null	Callback Port number (default: Same port number)	--callback-port 4723
-bp,--bootstrap-port	4724	(android-only) port number of the connected device	--bootstrap-port 4724
-k,--keep-artifacts	False	Deprecated, invalid. The trace information is now retained in the TMP directory, and the information in that directory is purged before each run. You can also refer to –trace-dir.
-r,--backend-retries	3	(ios-only) encountered crash or timed out, instrument the number of reboots.	--backend-retries 3
--session-override	False	Allow session to be overwritten (conflicting words)
--full-reset	False	(IOS) To delete the entire emulator directory. (Android) resets the app state by uninstalling the app instead of clearing the data. On Android, the app is also deleted when the session is completed.
--no-reset	False	Do not reset app status between sessions (IOS: Do not delete the app's plist file; Android: Do not delete apps until a new session is created). )
-l,--pre-launch	False	Pre-launch the app before the first session (IOS requires –app parameters, Android requires –app-pkg and –app-activity)
-lt,--launch-timeout	90000	(ios-only) time to wait for Instruments to start
-g,--log	Null	Output the log to the specified file	--log /path/to/appium.log
--log-level	Debug	Log level; Default (Console[:file]): debug[:d Ebug]	--log-level debug
--log-timestamp	False	Displaying timestamps in the terminal output
--local-timezone	False	Use local timestamp
--log-no-colors	False	Do not display colors in the terminal output
-G,--webhook	Null	Send log to HTTP listener at the same time	--webhook localhost:9876
--native-instruments-lib	False	(ios-only) IOS built a weird, impossible-to-avoid delay. We fixed it in the Appium. If you want to use the original, you can take this parameter.
--app-pkg	Null	(android-only) The Java package of the apk you want to run. (for example, COM.EXAMPLE.ANDROID.MYAPP)	--app-pkg com.example.android.myApp
--app-activity	Null	(android-only) The name of the Activity that was launched when the app was opened (for example, mainactivity)	--app-activity MainActivity
--app-wait-package	False	(android-only) The package name of the Activity you want to wait for. (e.g., com.example.android.myApp)	--app-wait-package com.example.android.myApp
--app-wait-activity	False	(android-only) The Activity name you want to wait for (for example, splashactivity)	--app-wait-activity SplashActivity
--android-coverage	False	(android-only) A fully qualified instrumentation class. As command adb shell am INSTRUMENT-E coverage true-w the-w parameter	--android-coverage com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation
--avd	Null	(android-only) The name of the AVD to start
--avd-args	Null	(android-only) Add additional parameters to the AVD to start	--avd-args -no-snapshot-load
--device-ready-timeout	5	(android-only) The time, in seconds, to wait for the device to be ready	--device-ready-timeout 5
--safari	False	(ios-only) using Safari Apps
--device-name	Null	The name of the mobile device you want to use	--device-name iPhone Retina (4-inch), Android Emulator
--platform-name	Null	Mobile platform Name: IOS, Android, or Firefoxos	--platform-name iOS
--platform-version	Null	Version of the mobile platform	--platform-version 7.1
--automation-name	Null	Name of the Automation tool: Appium or selendroid	--automation-name Appium
--browser-name	Null	Mobile Browser name: Safari or Chrome	--browser-name Safari
--default-device,-dd	False	(ios-simulator-only) Use instruments to launch its own default emulator
--force-iphone	False	(ios-only) Force the IPhone Simulator no matter what simulator the app is using
--force-ipad	False	(ios-only) Force the IPad Simulator no matter what simulator the app is using
--language	Null	Language of the Ios/android simulator	--language en
--locale	Null	Locale for the IOS simulator/android Emulator	--locale en_US
--calendar-format	Null	(ios-only) calendar format for IOS simulator	--calendar-format gregorian
--orientation	Null	(ios-only) When initializing a request, use LANDSCAPE (horizontal screen) or PORTRAIT (vertical screen)	--orientation LANDSCAPE
--tracetemplate	Null	(ios-only) Specifies the tracetemplate file used by Instruments	--tracetemplate /Users/me/Automation.tracetemplate
--show-sim-log	False	(ios-only) If set, the IOS emulator log will be written to the terminal
--show-ios-log	False	(ios-only) If set, the IOS system logs will be written to the terminal.
--nodeconfig	Null	Specifies a JSON-formatted configuration file that is used to register APPIUMD in the selenium grid	--nodeconfig /abs/path/to/nodeconfig.json
-ra,--robot-address	0.0.0.0	IP address of the robot	--robot-address 0.0.0.0
-rp,--robot-port	-1	Port address of the robot	--robot-port 4242
--selendroid-port	8080	The local port used to interact with the Selendroid	--selendroid-port 8080
--chromedriver-port	9515	Chromedriver Running ports	--chromedriver-port 9515
--chromedriver-executable	Null	Chromedriver the full path to the executable file
--use-keystore	False	(android-only) Set the KeyStore of the signature apk
--keystore-path	(android-only) path to KeyStore
--keystore-password	Android	(android-only) KeyStore's password
--key-alias	Androiddebugkey	(android-only) Alias for Key
--key-password	Android	(android-only) Key's password
--show-config	False	Print the configuration information for the Appium server, and then exit
--no-perms-check	False	Skip Appium to check whether the necessary files can be read/written
--command-timeout	60	The default receive command time-out for all sessions (no new commands are received within the timeout period, and the session is automatically closed). will be overwritten by a new time-out
--keep-keychains	False	(IOS) whether to keep keychains (library/keychains) when Appium starts or shuts down
--strict-caps	False	If the selected device is a valid device that Appium does not recognize, it will cause the session to fail
--isolate-sim-device	False	There is a bug in Xcode 6 where a particular emulator can only be built without any errors if other emulator devices are first deleted on some platforms. This option caused Appium to have to remove all other devices except the one being used. Note that this is a permanent deletion and you can use SIMCTL or Xcode to manage the device categories that are used by Appium.
--tmp	Null	A directory (absolute path) that can be used by Appium to manage temporary files, such as a built-in iOS application that needs to be moved. The default variable is the APPIUM_TMP_DIR directory that is set for *nix/mac to /tmp use the environment on Windows TEMP .
--trace-dir	Null	The Appium directory for saving iOS instruments trace, which is the absolute path and defaults to/appium-instruments
--intent-action	Android.intent.action.MAIN	(android-only) Intent action for initiating activity	--intent-action android.intent.action.MAIN
--intent-category	Android.intent.category.LAUNCHER	(android-only) Intent category for initiating activity	--intent-category android.intent.category.APP_CONTACTS
--intent-flags	0x10200000	(ANDROID-ONLY) flag to activate activity	--intent-flags 0x10200000
--intent-args	Null	(android-only) Additional intent parameters are included when starting activity	--intent-args 0x10200000
--suppress-adb-kill-server	False	(android-only) If set, prevents Appium from killing the ADB instance.

Appium Service Command-line arguments