Skip to main content

📋 Config

Configuration File​

To configure Sherlo, create a sherlo.config.json file at the root of your project

sherlo.config.json
{
  "token": "PROJECT_TOKEN", // "Qak6POAjBpoNhnS9RKqP_wR4Mt_2lnVLLTDyu0Ha1"
  "android": "BUILD_PATH", // "builds/simulator-preview/android.apk"
  "ios": "BUILD_PATH", // "builds/simulator-preview/ios.app"
  "devices": [
    {
      "id": "DEVICE_ID", // "iphone.15.pro"
      "osVersion": "OS_VERSION", // "17"
      "osTheme": "OPTIONAL_OS_THEME", // "light"
      "osLocale": "OPTIONAL_OS_LOCALE", // "en_US"
      "osFontScale": "OPTIONAL_OS_FONT_SCALE" // "0"
    }
  ]
}

Properties​

CLI Options​

note

Properties marked with * can be set via CLI options in 🧪 Testing Command:

  • token → --token
  • android → --android
  • ios → --ios

Token*​

The token is a unique key that authenticates your project with Sherlo

info

To get a token, create a new project or reset your current project's token in the Sherlo web application

sherlo.config.json
{
  "token": "PROJECT_TOKEN", // "Qak6POAjBpoNhnS9RKqP_wR4Mt_2lnVLLTDyu0Ha1"
  // ...
}

Android*​

The android property specifies the path to the Android build

sherlo.config.json
{
  "android": "BUILD_PATH" // "builds/simulator-preview/android.apk"
  // ...
}
Accepts .apk file format
note

Skip when using 🧪 Expo Cloud Builds testing command

iOS*​

The ios property specifies the path to the iOS build

sherlo.config.json
{
  "ios": "BUILD_PATH" // "builds/simulator-preview/ios.app"
  // ...
}
Accepts .app, or .tar.gz / .tar file format (as produced by EAS Build)
note

Skip when using 🧪 Expo Cloud Builds testing command

Devices​

The devices array specifies the configurations for testing devices

Each device includes:

  • id - unique device identifier
  • osVersion - operating system version
  • osTheme (default: "light") - operating system theme ("light" or "dark")
  • osLocale (default: "en_US") - operating system locale (language_COUNTRY format)
  • osFontScale (default: "0") - operating system font scale level ("-1", "0", "+1", etc.)
info

For a list of valid id and osVersion values, refer to the 📱 Devices page

List of valid osFontScale levels

iOS supports levels from "-3" to "+8":

  • "-3": 82%
  • "-2": 88%
  • "-1": 94%
  • "0": 100% (default)
  • "+1": 112%
  • "+2": 124%
  • "+3": 135%
  • "+4": 179%
  • "+5": 214%
  • "+6": 264%
  • "+7": 314%
  • "+8": 357%

Android supports levels from "-1" to "+2":

  • "-1": 85%
  • "0": 100% (default)
  • "+1": 115%
  • "+2": 130%
sherlo.config.json
{
  "devices": [
    {
      "id": "DEVICE_ID", // "iphone.15.pro"
      "osVersion": "OS_VERSION", // "17"
      "osTheme": "OPTIONAL_OS_THEME", // "light"
      "osLocale": "OPTIONAL_OS_LOCALE", // "en_US"
      "osFontScale": "OPTIONAL_OS_FONT_SCALE" // "0"
    },
    // ...
  ],
  // ...
}