Appium 配置文件

您可以将参数添加到一个特殊的配置文件中，而不是在命令行上将参数传递给 Appium。Appium 在运行时将从该配置文件中读取值。（请注意，CLI 参数优先于配置文件；如果在配置文件中和通过 CLI 参数设置了值，则优先使用 CLI 参数。）

支持的配置文件格式¶

您可以将配置数据存储在以下类型的文件中

JSON
YAML
JS（导出 JS 对象的 JavaScript 文件）
CJS（与上面相同；扩展名用于通用 JS）

警告

注意：目前不支持 ESM 格式的配置文件。

支持的配置文件位置¶

配置文件可以命名为任何名称，但以下文件名将被 Appium 自动发现并加载

.appiumrc.json（推荐）
.appiumrc.yaml
.appiumrc.yml
.appiumrc.js
.appiumrc.cjs
appium.config.js
appium.config.cjs
.appiumrc（被认为是 JSON）

此外，如果您的项目使用 Node.js，您可以在 package.json 中的 appium 属性中存储配置，它将被自动发现。

配置文件搜索¶

Appium 将从当前工作目录向上搜索目录树以查找这些文件之一。如果它到达当前用户的 home 目录或文件系统根目录，它将停止查找。

要指定配置文件的自定义位置，请使用 appium --config-file /path/to/config/file。

配置文件格式¶

首先，您可能想查看一些示例

还提供格式说明

用文字描述，配置文件将有一个根 server 属性，所有参数都是子属性。对于必须在命令行上以逗号分隔列表、JSON 字符串和/或外部文件路径的形式提供的某些属性，这些属性将改为其“本机”类型。例如，--use-plugins <value> 需要 <value> 是逗号分隔的字符串或指向分隔文件的路径。但是，配置文件只需要一个数组，例如

{
  "server": {
    "use-plugins": ["my-plugin", "some-other-plugin"]
  }
}

配置扩展（驱动程序和插件）¶

对于 driver 和 plugin 特定的配置，它们分别位于 server.driver 和 server.plugin 属性下。每个驱动程序或插件将有自己的命名属性，并且它提供的任何特定配置的值都在此之下。例如

{
  "server": {
    "driver": {
      "xcuitest": {
        "webkit-debug-proxy-port": 5400
      }
    }
  }
}

注意

以上配置对应于 --driver-xcuitest-webkit-debug-proxy-port CLI 参数。

所有属性区分大小写，并将使用 kebab-case。例如，callback-port 是允许的，但 callbackPort 不允许。