Build schema for eas.json

eas.json is your go-to place for configuring EAS Build (and EAS Submit). It is located at the root of your project next to your package.json.

This document is a reference that outlines the schema for the "build" key in eas.json. For an explanation of how to use it, please refer to "Configuring EAS Build eas.json".

Examples

A managed project with several profiles

{
  "build": {
    "base": {
      "node": "12.13.0",
      "yarn": "1.22.5",
      "env": {
        "EXAMPLE_ENV": "example value"
      },
      "android": {
        "image": "default",
        "env": {
          "PLATFORM": "android"
        }
      },
      "ios": {
        "image": "latest",
        "env": {
          "PLATFORM": "ios"
        }
      }
    },
    "development": {
      "extends": "base",
      "developmentClient": true,
      "env": {
        "ENVIRONMENT": "development"
      },
      "android": {
        "distribution": "internal",
        "withoutCredentials": true
      },
      "ios": {
        "simulator": true
      }
    },
    "staging": {
      "extends": "base",
      "env": {
        "ENVIRONMENT": "staging"
      },
      "distribution": "internal",
      "android": {
        "buildType": "apk"
      }
    },
    "production": {
      "extends": "base",
      "env": {
        "ENVIRONMENT": "production"
      }
    }
  }
}

A bare project with several profiles

{
  "build": {
    "base": {
      "env": {
        "EXAMPLE_ENV": "example value"
      },
      "android": {
        "image": "ubuntu-18.04-android-30-ndk-r19c",
        "ndk": "21.4.7075529"
      },
      "ios": {
        "image": "latest",
        "node": "12.13.0",
        "yarn": "1.22.5"
      }
    },
    "development": {
      "extends": "base",
      "env": {
        "ENVIRONMENT": "staging"
      },
      "android": {
        "distribution": "internal",
        "withoutCredentials": true,
        "gradleCommand": ":app:assembleDebug"
      },
      "ios": {
        "simulator": true,
        "buildConfiguration": "Debug"
      }
    },
    "staging": {
      "extends": "base",
      "env": {
        "ENVIRONMENT": "staging"
      },
      "distribution": "internal",
      "android": {
        "gradleCommand": ":app:assembleRelease"
      }
    },
    "production": {
      "extends": "base",
      "env": {
        "ENVIRONMENT": "production"
      }
    }
  }
}

Schema

{
  "cli": {
    "version": "SEMVER_RANGE",
    "requireCommit": boolean
  },
  "build": {
    "BUILD_PROFILE_NAME_1": {
      ...COMMON_OPTIONS,

      "android": {
        ...COMMON_OPTIONS,
        ...ANDROID_OPTIONS
      },

      "ios": {
        ...COMMON_OPTIONS,
        ...IOS_OPTIONS
      }
    },
    "BUILD_PROFILE_NAME_2": {},
    ...
  }
}

You can specify common options both in the platform-specific configuration object or at the profile's root. The platform-specific options take precedence over globally-defined ones.

EAS Submit is also configured in eas.json. You can find the reference for the "submit" fields in "Configuring EAS Submit with eas.json".

Options common to both platforms

Property	Description
`extends`	(string) - The name of the build profile that the current one should inherit values from. This value can't be specified per platform.
`credentialsSource`	(enum: local, remote) - The source of credentials used to sign build artifacts. `local` - if you want to provide your own `credentials.json` file. (learn more on this here). `remote` - if you want to use the credentials managed by EAS (this is the default option).
`releaseChannel`	(string) - Name of the release channel for the `expo-updates` package (Learn more about this). If you do not specify a channel, your binary will pull releases from the `default` channel. If you do not use `expo-updates` in your project then this property will have no effect. This field only applies to the Classic Update service; if you use EAS Update, use the channel field instead.
`channel`	(string) - The channel is a name we can give to multiple builds to identify them easily. Learn more. This field only applies to the EAS Update service, if your project still uses Classic Updates then use the releaseChannel field instead.
`distribution`	(enum: store, internal) - The method of distributing your app. `internal` - with this option you'll be able to share your build URLs with anyone, and they will be able to install the builds to their devices straight from the Expo website. When using `internal`, make sure the build produces an APK or IPA file. Otherwise, the sharable URL will be useless. Learn more about internal distribution. `store` - produces builds for store uploads, your build URLs won't be sharable.
`developmentClient`	(boolean) - If set to true (defaults to false), this field expresses the intent to produce a development client build. For the build to be successful, the project must have expo-dev-client installed and configured. Note: this field is sugar for setting the iOS `buildConfiguration` to `Debug` and Android `gradleCommand` to `:app:assembleDebug`. Those fields, if provided for the same build profile, will take precedence. Learn more about custom development clients.
`prebuildCommand`	(string) - Optional override of the prebuild command used by EAS. For example, you can specify `prebuild --template example-template` to use a custom template. Note: `--platform` and `--non-interactive` will be added automatically by the build engine, so you do not need to specify them manually. Learn more about prebuild options.
`node`	(string) - Version of Node.js.
`yarn`	(string) - Version of Yarn.
`expoCli`	(string) - Version of expo-cli used to prebuild your app. It does not have any effect on bare projects.
`env`	(object) - Environment variables that should be set during the build process (should only be used for values that you would commit to your git repository, i.e. not passwords or secrets).
`cache`	(object) - Cache configuration. This feature is intended for caching values that require a lot of computation, e.g. compilation results (both final binaries and any intermediate files), but it wouldn't work well for `node_modules` because the cache is not local to the machine, so the download speed is similar to downloading from the npm registry.
`disabled`	(boolean) - Disables caching. Defaults to false.
`key`	(string) - Cache key. You can invalidate the cache by changing this value.
`customPaths`	(array) - List of the paths that will be saved after a successful build and restored at the beginning of the next one. Both absolute and relative paths are supported, where relative paths are resolved from the directory with `eas.json`.
`cacheDefaultPaths`	(boolean) - Specifies whether to cache the recommended set of files, currently only Podfile.lock is cached by default for iOS build and nothing is cached for Android. Defaults to true.

Android-specific options

Property	Description
`withoutCredentials`	(boolean) - When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when you want to build debug binaries and the debug keystore is checked in to the repository. The default is `false`.
`image`	(string) - Image with build environment. Learn more about it here.
`ndk`	(string) - Version of Android NDK.
`autoIncrement`	(boolean \| "version" \| "versionCode") - Controls how EAS CLI bumps your application build version. Defaults to `false`. Allowed values: `"version"` - the patch of `expo.version` is bumped (e.g. `1.2.3` -> `1.2.4`). `"versionCode"` (or `true`) - `expo.android.versionCode` is bumped (e.g. `3` -> `4`). `false` - versions won't be bumped automatically (default) In the case of a bare project, it also updates versions in native code. `expo.version` corresponds to `versionName` and `expo.android.versionCode` to `versionCode` in the `build.gradle`. Google Play uses these values to identify the app build, `versionName` is the version visible to users, whereas `versionCode` defines the version number. The combination of those needs to be unique, so you can bump either of them. This feature is not intended for use with dynamic configuration (app.config.js). EAS CLI will throw an error if you don't use app.json.
`buildType`	(enum: app-bundle, apk) - Type of the artifact you want to build. It controls what Gradle task will be used, can be overridden by `gradleCommand` or `developmentClient: true` option. `app-bundle` - `:app:bundleRelease` `apk` - `:app:assembleRelease`
`gradleCommand`	(string) - Gradle task that will be used to build your project, e.g. `:app:assembleDebug` to build a debug binary. It's not recommended unless you need to run a task that `buildType` does not support, it takes priority over `buildType` and `developmentClient`.
`artifactPath`	(string) - Path (or pattern) where EAS Build is going to look for the build artifacts. EAS Build uses the `fast-glob` npm package for pattern matching (see their README to learn more about the syntax you can use). The default value is `android/app/build/outputs/*/.{apk,aab}`.

iOS-specific options

Property	Description
`simulator`	(boolean) - If set to true, creates build for simulator. Defaults to false
`enterpriseProvisioning`	(enum: universal, adhoc) - Provisioning method used for `"distribution": "internal"` when you have an Apple account with Apple Developer Enterprise Program membership. You can choose if you want to use `adhoc` or `universal` provisioning. The latter is recommended as it does not require you to register each individual device. If you don't provide this option and you still authenticate with an enterprise team, you'll be prompted which provisioning method to use.
`autoIncrement`	(boolean \| "version" \| "buildNumber") - Controls how EAS CLI bumps your application build version. Defaults to `false`. Allowed values: `"version"` - the patch of `expo.version` is bumped (e.g. `1.2.3` -> `1.2.4`). `"buildNumber"` (or `true`) - the last component of `expo.ios.buildNumber` is bumped (e.g. `1.2.3.39` -> `1.2.3.40`). `false` - versions won't be bumped automatically (default) In the case of a bare project, it also updates versions in native code. `expo.version` corresponds to `CFBundleShortVersionString` and `expo.ios.buildNumber` to `CFBundleVersion` in the `Info.plist`. The App Store is using those values to identify the app build, `CFBundleShortVersionString` is the version visible to users, whereas `CFBundleVersion` defines the build number. The combination of those needs to be unique, so you can bump either of them. This feature is not intended for use with dynamic configuration (app.config.js). EAS CLI will throw an error if you don't use app.json.
`image`	(string) - Image with build environment. Learn more about it here.
`bundler`	(string) - Version of bundler.
`fastlane`	(string) - Version of fastlane.
`cocoapods`	(string) - Version of CocoaPods.
`scheme`	(string) - Xcode project's scheme. managed project: does not have any effect bare project If your project has multiple schemes, you should set this value. If the project has only one scheme, it will be detected automatically. If multiple schemes exist and this value is not set, EAS CLI will prompt you to select one of them.
`buildConfiguration`	(string) - Xcode project's Build Configuration. managed project: "Release" or "Debug", defaults to "Release" bare project: defaults to the value specified in the scheme It takes priority over `developmentClient` field.
`artifactPath`	(string) - Path (or pattern) where EAS Build is going to look for the build artifacts. EAS Build uses the `fast-glob` npm package for pattern matching, (see their README to learn more about the syntax you can use). You should modify that path only if you are using a custom `Gymfile`. The default is `ios/build/Build/Products/-iphonesimulator/.app` when building for simulator and `ios/build/*.ipa` in other cases.