eas-cli

eas-cli

EAS command line tool

• Installation
• Usage
• Commands

Installation

npm install -g eas-cli
# or
yarn global add eas-cli

Usage

eas COMMAND
# runs the command
eas (-v|--version|version)
# prints the version
eas --help COMMAND
# outputs help for specific command

Commands

• eas account:login
• eas account:logout
• eas account:view
• eas analytics [STATUS]
• eas branch:create [NAME]
• eas branch:delete [NAME]
• eas branch:list
• eas branch:rename
• eas branch:view [NAME]
• eas build
• eas build:cancel [BUILD_ID]
• eas build:configure
• eas build:inspect
• eas build:list
• eas build:view [BUILD_ID]
• eas channel:create [NAME]
• eas channel:edit [NAME]
• eas channel:list
• eas channel:view [NAME]
• eas config
• eas credentials
• eas device:create
• eas device:list
• eas device:view [UDID]
• eas diagnostics
• eas help [COMMAND]
• eas project:info
• eas project:init
• eas secret:create
• eas secret:delete
• eas secret:list
• eas submit
• eas update
• eas update:configure
• eas update:delete GROUPID
• eas update:view GROUPID
• eas webhook:create
• eas webhook:delete [ID]
• eas webhook:list
• eas webhook:update
• eas webhook:view ID

eas account:login

log in with your Expo account

USAGE
  $ eas account:login

ALIASES
  $ eas login

See code: src/commands/account/login.ts

eas account:logout

log out

USAGE
  $ eas account:logout

ALIASES
  $ eas logout

See code: src/commands/account/logout.ts

eas account:view

show the username you are logged in as

USAGE
  $ eas account:view

ALIASES
  $ eas whoami

See code: src/commands/account/view.ts

eas analytics [STATUS]

view or change analytics settings

USAGE
  $ eas analytics [STATUS]

See code: src/commands/analytics.ts

eas branch:create [NAME]

Create a branch on the current project.

USAGE
  $ eas branch:create [NAME]

ARGUMENTS
  NAME  Name of the branch to create

OPTIONS
  --json  return a json with the new branch ID and name.

See code: src/commands/branch/create.ts

eas branch:delete [NAME]

Delete a branch on the current project

USAGE
  $ eas branch:delete [NAME]

ARGUMENTS
  NAME  Name of the branch to delete

OPTIONS
  --json  return JSON with the edited branch's ID and name.

See code: src/commands/branch/delete.ts

eas branch:list

List all branches on this project.

USAGE
  $ eas branch:list

OPTIONS
  --json  return output as JSON

See code: src/commands/branch/list.ts

eas branch:rename

Rename a branch.

USAGE
  $ eas branch:rename

OPTIONS
  --from=from  current name of the branch.
  --json       return a json with the edited branch's ID and name.
  --to=to      new name of the branch.

See code: src/commands/branch/rename.ts

eas branch:view [NAME]

View a branch.

USAGE
  $ eas branch:view [NAME]

ARGUMENTS
  NAME  Name of the branch to view

OPTIONS
  --json  return a json with the branch's ID name and recent update groups.

See code: src/commands/branch/view.ts

eas build

Start a build

USAGE
  $ eas build

OPTIONS
  -p, --platform=(android|ios|all)

  --auto-submit                            Submit on build complete using the submit profile with the same name as the
                                           build profile

  --auto-submit-with-profile=PROFILE_NAME  Submit on build complete using the submit profile with provided name

  --clear-cache                            Clear cache before the build

  --json                                   Enable JSON output, non-JSON messages will be printed to stderr

  --local                                  Run build locally [experimental]

  --non-interactive                        Run command in non-interactive mode

  --profile=PROFILE_NAME                   Name of the build profile from eas.json. Defaults to "production" if defined
                                           in eas.json.

  --skip-project-configuration             Skip project configuration

  --[no-]wait                              Wait for build(s) to complete

See code: src/commands/build/index.ts

eas build:cancel [BUILD_ID]

Cancel a build.

USAGE
  $ eas build:cancel [BUILD_ID]

See code: src/commands/build/cancel.ts

eas build:configure

Configure the project to support EAS Build.

USAGE
  $ eas build:configure

OPTIONS
  -p, --platform=(android|ios|all)  Platform to configure

See code: src/commands/build/configure.ts

eas build:inspect

Inspect the state of the project at specific build stages. Useful for troubleshooting.

USAGE
  $ eas build:inspect

OPTIONS
  -p, --platform=(android|ios)
      (required)

  -s, --stage=(archive|pre-build|post-build)
      (required) Stage of the build you want to inspect.
           archive - builds the project archive that would be uploaded to EAS when building
           pre-build - prepares the project to be built with Gradle/Xcode. Does not run the native build.
           post-build - builds the native project and leaves the output directory for inspection

  --force
      Delete OUTPUT_DIRECTORY if it already exists.

  --output=OUTPUT_DIRECTORY
      (required) Output directory.

  --profile=PROFILE_NAME
      Name of the build profile from eas.json. Defaults to "production" if defined in eas.json.

  --verbose

See code: src/commands/build/inspect.ts

eas build:list

list all builds for your project

USAGE
  $ eas build:list

OPTIONS
  --appBuildVersion=appBuildVersion
  --appIdentifier=appIdentifier
  --appVersion=appVersion
  --buildProfile=buildProfile
  --channel=channel
  --distribution=(store|internal|simulator)
  --gitCommitHash=gitCommitHash

  --json                                                         Enable JSON output, non-JSON messages will be printed
                                                                 to stderr

  --limit=limit

  --platform=(all|android|ios)

  --runtimeVersion=runtimeVersion

  --sdkVersion=sdkVersion

  --status=(new|in-queue|in-progress|errored|finished|canceled)

See code: src/commands/build/list.ts

eas build:view [BUILD_ID]

view a build for your project

USAGE
  $ eas build:view [BUILD_ID]

OPTIONS
  --json  Enable JSON output, non-JSON messages will be printed to stderr

See code: src/commands/build/view.ts

eas channel:create [NAME]

Create a channel on the current project.

USAGE
  $ eas channel:create [NAME]

ARGUMENTS
  NAME  Name of the channel to create

OPTIONS
  --json  print output as a JSON object with the new channel ID, name and branch mapping.

See code: src/commands/channel/create.ts

eas channel:edit [NAME]

Point a channel at a new branch.

USAGE
  $ eas channel:edit [NAME]

ARGUMENTS
  NAME  Name of the channel to edit

OPTIONS
  --branch=branch  Name of the branch to point to
  --json           print output as a JSON object with the channel ID, name and branch mapping.

See code: src/commands/channel/edit.ts

eas channel:list

List all channels on the current project.

USAGE
  $ eas channel:list

OPTIONS
  --json  print output as a JSON object with the channel ID, name and branch mapping.

See code: src/commands/channel/list.ts

eas channel:view [NAME]

View a channel on the current project.

USAGE
  $ eas channel:view [NAME]

ARGUMENTS
  NAME  Name of the channel to view

OPTIONS
  --json  print output as a JSON object with the channel ID, name and branch mapping.

See code: src/commands/channel/view.ts

eas config

show the eas.json config

USAGE
  $ eas config

OPTIONS
  -p, --platform=(android|ios)
  --profile=profile

See code: src/commands/config.ts

eas credentials

manage your credentials

USAGE
  $ eas credentials

See code: src/commands/credentials.ts

eas device:create

register new Apple Devices to use for internal distribution

USAGE
  $ eas device:create

See code: src/commands/device/create.ts

eas device:list

list all registered devices for your account

USAGE
  $ eas device:list

OPTIONS
  --apple-team-id=apple-team-id

See code: src/commands/device/list.ts

eas device:view [UDID]

view a device for your project

USAGE
  $ eas device:view [UDID]

See code: src/commands/device/view.ts

eas diagnostics

log environment info to the console

USAGE
  $ eas diagnostics

See code: src/commands/diagnostics.ts

eas help [COMMAND]

display help for eas

USAGE
  $ eas help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

eas project:info

information about the current project

USAGE
  $ eas project:info

See code: src/commands/project/info.ts

eas project:init

create or link an EAS project

USAGE
  $ eas project:init

ALIASES
  $ eas init

See code: src/commands/project/init.ts

eas secret:create

Create an environment secret on the current project or owner account.

USAGE
  $ eas secret:create

OPTIONS
  --force                    Delete and recreate existing secrets
  --name=name                Name of the secret
  --scope=(account|project)  [default: project] Scope for the secret
  --value=value              Value of the secret

See code: src/commands/secret/create.ts

eas secret:delete

Delete an environment secret by ID.

USAGE
  $ eas secret:delete

OPTIONS
  --id=id  ID of the secret to delete

DESCRIPTION
  Unsure where to find the secret's ID? Run eas secret:list

See code: src/commands/secret/delete.ts

eas secret:list

Lists environment secrets available for your current app

USAGE
  $ eas secret:list

See code: src/commands/secret/list.ts

eas submit

Submit build archive to App Store Connect

USAGE
  $ eas submit

OPTIONS
  -p, --platform=(android|ios|all)
  --id=id                           ID of the build to submit
  --latest                          Submit the latest build for specified platform
  --non-interactive                 Run command in non-interactive mode
  --path=path                       Path to the .apk/.aab/.ipa file

  --profile=profile                 Name of the submit profile from eas.json. Defaults to "production" if defined in
                                    eas.json.

  --url=url                         App archive url

  --verbose                         Always print logs from Submission Service

  --[no-]wait                       Wait for submission to complete

DESCRIPTION
  See how to configure submits with eas.json: https://docs.expo.dev/submit/eas-json/

ALIASES
  $ eas build:submit

See code: src/commands/submit.ts

eas update

Publish an update group.

USAGE
  $ eas update

OPTIONS
  -p, --platform=(android|ios|all)  [default: all]
  --auto                            Use the current git branch and commit message for the EAS branch and update message
  --branch=branch                   Branch to publish the update group on
  --group=group                     Update group to republish
  --input-dir=input-dir             [default: dist] Location of the bundle
  --json                            Enable JSON output, non-JSON messages will be printed to stderr
  --message=message                 A short message describing the update
  --republish                       Republish an update group
  --skip-bundler                    Skip running Expo CLI to bundle the app before publishing

See code: src/commands/update/index.ts

eas update:configure

Configure the project to support EAS Update.

USAGE
  $ eas update:configure

See code: src/commands/update/configure.ts

eas update:delete GROUPID

Delete all the updates in an update Group.

USAGE
  $ eas update:delete GROUPID

ARGUMENTS
  GROUPID  The ID of an update group to delete.

OPTIONS
  --json  Return a json with the group ID of the deleted updates.

See code: src/commands/update/delete.ts

eas update:view GROUPID

Update group details.

USAGE
  $ eas update:view GROUPID

ARGUMENTS
  GROUPID  The ID of an update group.

OPTIONS
  --json  Return a json with the updates belonging to the group.

See code: src/commands/update/view.ts

eas webhook:create

Create a webhook on the current project.

USAGE
  $ eas webhook:create

OPTIONS
  --event=(BUILD|SUBMIT)  Event type that triggers the webhook

  --secret=secret         Secret used to create a hash signature of the request payload, provided in the
                          'Expo-Signature' header.

  --url=url               Webhook URL

See code: src/commands/webhook/create.ts

eas webhook:delete [ID]

Delete a webhook on the current project.

USAGE
  $ eas webhook:delete [ID]

ARGUMENTS
  ID  ID of the webhook to delete

See code: src/commands/webhook/delete.ts

eas webhook:list

List webhooks on the current project.

USAGE
  $ eas webhook:list

OPTIONS
  --event=(BUILD|SUBMIT)  Event type that triggers the webhook

See code: src/commands/webhook/list.ts

eas webhook:update

Create a webhook on the current project.

USAGE
  $ eas webhook:update

OPTIONS
  --event=(BUILD|SUBMIT)  Event type that triggers the webhook
  --id=id                 (required) Webhook ID

  --secret=secret         Secret used to create a hash signature of the request payload, provided in the
                          'Expo-Signature' header.

  --url=url               Webhook URL

See code: src/commands/webhook/update.ts

eas webhook:view ID

View a webhook on the current project.

USAGE
  $ eas webhook:view ID

ARGUMENTS
  ID  ID of the webhook to view

See code: src/commands/webhook/view.ts

Changelog

0.41.1 - 2021-12-16

🎉 New features

• Adds commands for EAS Update, which is now in preview for subscribers. EAS Update makes fixing small bugs and pushing quick fixes a snap in between app store submissions. It accomplishes this by allowing an end-user's app to swap out the non-native parts of their app (for example, JS, styling, and image changes) with a new update that contains bug fixes and other updates. (#854 by @jonsamp)
  • Adds eas update, which can bundle and publish updates on a branch.
  • Adds eas branch, which manages branches. Branches contain a list of updates and are linked to channels.
  • Adds eas channel, which manages channels. Channels are specified inside builds and are linked to branches, allowing us to link specific updates with specific builds.
  • Read more in our feature preview docs.

🐛 Bug fixes

• Fix eas submit displaying a prompt in non-interactive mode when some ASC API credentials are missing in eas.json. (#841 by @barthap)