@nx/expo - Executors

The @nx/expo plugin provides various executors to help you create and configure expo projects within your Nx workspace. Below is a complete reference for all available executors and their options.

For an overview of the plugin and setup instructions, see the @nx/expo introduction.

build-list

List all Expo Application Services (EAS) builds for your Expo project.

The build-list command allows to check the details of your Expo Application Services (EAS) build status.

project.json:

{
  "name": "mobile",
  //...
  "targets": {
    //...
    "build-list": {
      "executor": "@nx/expo:build-list",
      "options": {}
    }
    //...
  }
}

nx run mobile:build-list

Examples

Get Status of Different Platforms

The platform option allows you to check build status of different platform (e.g. android, ios, all):

    "build-list": {
      "executor": "@nx/expo:build-list",
      "options": {
        "platform": "ios"
      }
    }

Get Status Interactively

The interactive option allows you to specify whether to use interactive mode:

    "build-list": {
      "executor": "@nx/expo:build-list",
      "options": {
        "interactive": true
      }
    }

Get Status in JSON Format

The json option allows you to print the output in JSON format:

    "build-list": {
      "executor": "@nx/expo:build-list",
      "options": {
        "interactive": false,
        "json": true
      }
    }

---

Options

Option	Type	Description	Default
appBuildVersion	string	App build version of EAS build
appIdentifier	string	App identifier of EAS build
appVersion	string	App version of EAS build
buildProfile	string	Build profile of EAS build
channel	string	Channel of EAS build
distribution	any	Distribution of EAS build
gitCommitHash	string	Git commit hash of EAS build
interactive	boolean	Run the command in interactive mode.
json	boolean	Enable JSON output, non-JSON messages will be printed to stderr
limit	number	Limit of numbers to list EAS builds
platform	any	The platform to build the app.
runtimeVersion	string	Runtime version of EAS build
sdkVersion	string	SDK version of EAS build
status	any	Status of EAS build

ensure-symlink

Ensure workspace node_modules is symlink under app’s node_modules folder.

sync-deps

Updates package.json with project dependencies.

Options

Option	Type	Description	Default
all	boolean	Copy all dependencies and devDependencies from the workspace root package.json.	false
exclude	array	An array of npm packages to exclude.	[]
excludeImplicit	boolean	This will ignore npm packages from projects listed in implicitDependencies (e.g. backend API projects)	false
include	array	An array of additional npm packages to include.	[]

update

Start an EAS update for your expo project.

Options

Option	Type	Description	Default
auto	boolean	Use the current git branch and commit message for the EAS branch and update message	false
branch	string	Branch to publish the update group on
group	string	Update group to republish
inputDir	string	Location of the bundle
interactive	boolean	Run command in interactive mode	true
json	boolean	Enable JSON output, non-JSON messages will be printed to stderr	false
message	string	A short message describing the update
platform	any	The platform to build the app, example values: ios, android, all.	"all"
privateKeyPath	string	File containing the PEM-encoded private key corresponding to the certificate in expo-updates’ configuration. Defaults to a file named “private-key.pem” in the certificate’s directory.
republish	boolean	Republish a previous update within a branch	false
skipBundler	boolean	Skip running Expo CLI to bundle the app before publishing	false