CLI Arguments · Appium 官方文檔

# Appium 服務器參數許多 Appium 1.5 中的服務器參數已被棄用，取而代之使用的是 [-default-capabilities 標識](../../writing-running-appium/default-capabilities-arg.md) 。用法：node . [標志] ## 服務器標志所有標志都是可選的，但是有些必須跟指定標志組合使用才生效。 <expand_table> |標志|默認|描述|示例| |----|----|----|----| |`--shell`|null| 進入 REPL 模式 || |`--allow-cors`|false|打開 CORS 兼容模式，這將允許從托管在任何域中的網站內連接到 Appium 服務器。啟用此功能時要小心，因為如果您訪問的網站使用跨域請求，在 Appium 服務器上啟動或運行內省會話，則可能存在安全風險。|| |`--ipa`|null| （僅 iOS）.ipa 文件的絕對路徑 | `--ipa /abs/path/to/my.ipa` | |`-a`, `--address`|0.0.0.0| 監聽的 ip 地址 | `--address 0.0.0.0` | |`-p`, `--port`|4723| 監聽的端口 | `--port 4723` | |`-ca`, `--callback-address`|null| 回調 ip 地址 (默認：與 --address 相同） | `--callback-address 127.0.0.1` | |`-cp`, `--callback-port`|null| 回調端口（默認：與 --port 相同） | `--callback-port 4723` | |`-bp`, `--bootstrap-port`|4724| （僅 Android）設備跟 Appium 通信的端口 | `--bootstrap-port 4724` | |`-r`, `--backend-retries`|3| （僅 iOS）遇到 crash 或者超時，嘗試重啟Instruments的次數 | `--backend-retries 3` | |`--session-override`|false| 允許 session 覆蓋（如有沖突）|| |`-l`, `--pre-launch`|false| 首次建立session時預啟動應用（iOS 需要 –app 參數，Android 需要 –app-pkg 和 –app-activity 參數）|| |`-g`, `--log`|null| 將日志輸出到指定文件 | `--log /path/to/appium.log` | |`--log-level`|debug| 為控制臺和日志文件設置服務器日志等級（值為 `console-level:logfile-level`，如果只提供一個值，則兩者相同）。可選的值為 `debug`、`info`、`warn`、`error`，并且越往后，日志越少。| `--log-level error:debug` | |`--log-timestamp`|false| 在終端輸出中顯示時間戳 || |`--local-timezone`|false| 時間戳使用本地時區 || |`--log-no-colors`|false| 終端輸出不為彩色 || |`-G`, `--webhook`|null| 同時發送日志輸出到 HTTP 監聽器 | `--webhook localhost:9876` | |`--safari`|false| （僅iOS）使用 safari 應用程序 || |`--default-device`, `-dd`|false| （僅iOS模擬器）使用默認模擬器啟動 Instruments || |`--force-iphone`|false| (僅 iOS）不管應用程序指定什么設備，都強制使用 iPhone 模擬器|| |`--force-ipad`|false| (僅 iOS）不管應用程序指定什么設備，都強制使用 iPad 模擬器|| |`--tracetemplate`|null|(僅 iOS) 指定 Instruments 所使用的 .tracetemplate 文件 | `--tracetemplate /Users/me/Automation.tracetemplate` | |`--instruments`|null| （僅 iOS）Instruments 二進制文件的路徑 | `--instruments /path/to/instruments` | |`--nodeconfig`|null| 指定 JSON 格式的配置文件，用于在 selenium grid 中注冊 appium | `--nodeconfig /abs/path/to/nodeconfig.json` | |`-ra`, `--robot-address`|0.0.0.0| robot 的 IP 地址 | `--robot-address 0.0.0.0` | |`-rp`, `--robot-port`|-1| robot 的端口號 | `--robot-port 4242` | |`--selendroid-port`|8080| 用于和 Selendroid 通信的本地端口 | `--selendroid-port 8080` | |`--chromedriver-port`|9515| ChromeDriver 運行使用的端口 | `--chromedriver-port 9515` | |`--chromedriver-executable`|null| ChromeDriver 可執行文件的完整路徑 || |`--show-config`|false| 打印 appium 服務器的配置信息，然后退出 || |`--no-perms-check`|false| 繞過Appium檢查，確保我們可以讀 / 寫必要的文件|| |`--strict-caps`|false| 如果所選設備不能被 appium 有效識別，則導致會話失敗 || |`--isolate-sim-device`|false| Xcode 6 在某些平臺上存在存在一個 bug，想要正確啟動某個模擬器，只能去刪除掉所有其他模擬器。這個選項將導致了 Appium 刪除除了正在使用的設備以外其他所有設備。請注意，這是永久性刪除，你可以使用 simctl 或 xcode 管理被 Appium 使用的設備類別。 || |`--tmp`|null| 目錄的絕對路徑將被 Appium 用于管理臨時文件，比如存放需要移動的內置 iOS 應用程序。在 *nix / Mac 上默認為 /tmp，在 Windows 上默認為 C:\Windows\Temp || |`--trace-dir`|null| appium 用于保存iOS instruments 軌跡的目錄，是絕對路徑，默認為 <tmp dir>/appium-instruments || |`--debug-log-spacing`|false| 在日志中加大間距，幫助進行視覺檢查|| |`--suppress-adb-kill-server`|false| （僅 Android) 如果設置了，可以阻止 Appium 殺掉 adb 實例|| |`--async-trace`|false| 向日志條目添加長堆棧追蹤。建議僅在調試時使用 || |`--webkit-debug-proxy-port`|27753|（僅 iOS）用于 ios-webkit-debug-proxy 通信的本地端口 | `--webkit-debug-proxy-port 27753` | |`-dc`, `--default-capabilities`|{}| 設置默認預期功能（Desired capabilities），每個會話都將使用默認預期功能，除非被新的功能覆蓋 | `--default-capabilities [ '{"app": "myapp.app", "deviceName": "iPhone Simulator"}' | /path/to/caps.json ]` | |`--reboot`|false| - （僅 Android）每次建立會話都重啟模擬器，會話結束后殺掉模擬器 || |`--command-timeout`|60| 【棄用】- 沒有效果。這曾是服務器用于所有會話接收命令的默認超時時間（單位是秒，但不超過 2147483）。預期能力（Desired capabilities）中的 newCommandTimeout 替代 || |`-k`, `--keep-artifacts`|false| 【棄用】 - 沒有效果。trace 現在默認位于 tmp 目錄下，每次運行前都會清除。請查考 --trace-dir 標識 || |`--platform-name`|null| 【棄用】 - 移動平臺名稱：iOS、Android 或 FirefoxOS | `--platform-name iOS`| |`--platform-version`|null| 【棄用】 - 移動平臺的版本號 | `--platform-version 7.1` | |`--automation-name`|null| 【棄用】 - 自動化工具的名稱: Appium 或 Selendroid | `--automation-name Appium` | |`--device-name`|null| 【棄用】 - 將使用的移動設備的名稱 | `--device-name iPhone Retina (4-inch), Android Emulator` | |`--browser-name`|null| 【棄用】 - 移動瀏覽器的名稱: Safari 或者 Chrome | `--browser-name Safari` | |`--app`|nul| 【棄用】 - IOS：基于模擬器編譯的 .app 文件的絕對路徑或者設備上目標的 BundleId； Android：.apk 文件的絕對路徑 | `--app /abs/path/to/my.app` | |`-lt`, `--launch-timeout`|90000| 【棄用】 - (僅iOS) Instruments啟動等待時間（單位：ms） || |`--language`|null| 【棄用】 - iOS 模擬器 / Android 模擬器的語言 | `--language en` | |`--locale`|null| 【棄用】 - iOS 模擬器 / Android 模擬器的區域 | `--locale en_US` | |`-U`, `--udid`|null| 【棄用】 - 連接的物理設備的 udid | `--udid 1adsf-sdfas-asdf-123sdf` | |`--orientation`|null| 【棄用】 - （僅 iOS) 初始化請求時，使用 LANDSCAPE 或者 PORTRAIT | `--orientation LANDSCAPE` | |`--no-reset`|false| 【棄用】 - 會話（session）之間不重置應用狀態（IOS: 不刪除應用的 plist 文件；Android：在創建一個新的session前不刪除應用） || |`--full-reset`|false| 【棄用】 - （iOS）刪除整個模擬器目錄。（Android）通過卸載應用（而不是清除數據）重置應用狀態。在 Android 中會話（session）完成后也會刪除應用。 || |`--app-pkg`|null| 【棄用】 - （僅 Android）想要運行的 apk 的 java 包（例如， com.example.android.myApp） | `--app-pkg com.example.android.myApp`| |`--app-activity`|null| 【棄用】 - （僅 Android）打開應用時，想要啟動的 Activity 的名稱（例如 MainActivity） | `--app-activity MainActivity` | |`--app-wait-package`|false| 【棄用】 - （僅 Andorid）想要等待的 activity 的包名（例如 com.example.android.myApp） | `--app-wait-package com.example.android.myApp` | |`--app-wait-activity`|false| 【棄用】 - （僅 Andorid）想要等待的 activity 名（例如 SplashActivity） | `--app-wait-activity SplashActivity` | |`--device-ready-timeout`|5| 【棄用】 - （僅 Andorid）等待設備準備就緒的超時時間（單位：秒）| `--device-ready-timeout 5` | |`--android-coverage`|false| 【棄用】 - （僅 Andorid）完全符合條件的 instrumentation 類，作為命令 adb shell am instrument -e coverage true -w 中的 -w 的參數 | `--android-coverage com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation` | |`--avd`|null| 【棄用】 - （僅 Andorid）要啟動的安卓虛擬設備的名稱 | `--avd @default` | |`--avd-args`|null| 【棄用】 - （僅 Andorid）啟動安裝虛擬設備時額外的模擬器參數 | `--avd-args -no-snapshot-load` | |`--use-keystore`|false| 【棄用】 - （僅 Andorid）設置 apk 簽名的 keystore|| |`--keystore-path`|<user>/.android/debug.keystore| 【棄用】 - （僅 Andorid）keystore 的路徑 || |`--keystore-password`|android| 【棄用】 - （僅 Andorid）keystore 的密碼|| |`--key-alias`|androiddebugkey| 【棄用】 - （僅 Andorid）key 的別名|| |`--key-password`|android| 【棄用】 - （僅 Andorid）key 的密碼 || |`--intent-action`|android.intent.action.MAIN| 【棄用】 - （僅 Andorid）用于啟動 activity 的 Intent action | `--intent-action android.intent.action.MAIN` | |`--intent-category`|android.intent.category.LAUNCHER| 【棄用】 - （僅 Andorid）用于啟動 activity 的 Intent category | `--intent-category android.intent.category.APP_CONTACTS` | |`--intent-flags`| 0x10200000| 【棄用】 - （僅 Andorid）啟動 activity 的標識 | `--intent-flags 0x10200000` | |`--intent-args`|null| 【棄用】 - （僅 Andorid）啟動 activity 時附帶額外的 intent 參數 | `--intent-args 0x10200000` | |`--dont-stop-app-on-reset`|false| 【棄用】 - （僅 Andorid）用于設置 appium 重啟時是否先殺掉 app || |`--calendar-format`|null| 【棄用】 - （僅 iOS）iOS 模擬器的日歷格式 | `--calendar-format gregorian` | |`--native-instruments-lib`|false| 【棄用】 - （僅 iOS）iOS 內建了一個怪異的不可能避免的延遲，我們在Appium里修復了它，如果你想用原來的，你可以使用這個參數 || |`--keep-keychains`|false| 【棄用】 - （僅 iOS）當 Appium 啟動或者關閉的時候，是否保留keychains（Library / Keychains） || |`--localizable-strings-dir`|en.lproj| 【棄用】 - （僅 iOS）Localizable.strings 與目錄的相對路徑 | `--localizable-strings-dir en.lproj` | |`--show-ios-log`|false| 【棄用】 - （僅 iOS）如果設置了，iOS 系統日志將會輸出到終端 || |`--relaxed-security`|false|禁用額外的安全檢查，因此可以使用支持此選項的驅動程序提供的某些高級功能。只有當所有客戶端都位于可信任網絡中，才啟用它；如果客戶端可能會突破會話沙箱，則不應該啟用它。|| |`--deny-insecure`|[]|設置禁用的功能列表，即便 --relaxed-security 開關已經打開，而且功能名字也在 --allow-insecure 參數中設置了，也不會啟用。設置的值是以逗號為分隔符的列表或是按行分隔的文本路徑。可參考 [security doc](../writing-running-appium/security.md)|`--deny-insecure=foo,bar`| |`--log-filters`|null|設置包含一個或多個日志篩選規則的JSON文件路徑。該功能在需要混淆敏感信息場景下非常有用，比如混淆那些可能存在于日志中的敏感信息，如密碼或訪問令牌。日志篩選的具體規則在 https://github.com/appium/appium-support/blob/master/lib/log-internal.js. 如果任何規則有問題，在服務器啟動時將引發異常。|`--log-filters=/home/config.json`| --- EOF. 本文由 [testly](https://github.com/testly) @[Pandorym](https://github.com/Pandorym) 和 [windanchaos](https://gitee.com/windanchaos)翻譯，由 [lihuazhang](https://github.com/lihuazhang) 校驗。