Codemagic read-only environment variables

Useful variables exported during builds

Codemagic exports several read-only environment variables during the build that you can use in scripts to customize the build process. Environment variables added by user will override Codemagic defaults. You can check which environment variables are exported by inserting the following script before or after any of the default build steps:

#!/bin/sh
set -ex
printenv

Here you’ll find some of the read-only environment variables explained.

Environment variableValue
ANDROID_SDK_ROOTAbsolute path to Android SDK and tools
CItrue
CONTINUOUS_INTEGRATIONtrue
BUILD_NUMBERNumber of the build for this project in Codemagic for the given workflow
PROJECT_BUILD_NUMBERNumber of the build for this project in Codemagic
FLUTTER_ROOTAbsolute path to Flutter SDK
FCI_BRANCHThe current branch being built, for pull requests it is the source branch
FCI_TAGThe tag being built if started from a tag webhook, unset otherwise
FCI_REPO_SLUGThe slug of the repository that is currently being built in the form owner_name/repository_name. Unset for repositories added from custom source
FCI_COMMITCommit hash that is currently being built by Codemagic, for pull request builds it is the hash of the source commit
FCI_PREVIOUS_COMMITCommit hash of the previous successful build, unset if there is no previous successful build
FCI_PULL_REQUESTtrue, if the current build is building a pull request, false otherwise
FCI_PULL_REQUEST_NUMBERSet to Integer ID of the pull request for the Git provider (Bitbucket, Github etc) if the current build is building a pull request, unset otherwise
FCI_PULL_REQUEST_DESTThe destination branch, if the current build is building a pull request, unset otherwise
FCI_CLONE_UNSHALLOWIf set to true performs a full clone of the repository instead of top 50 commits
FCI_CLONE_DEPTHSpecifies the number of commits to be fetched from the repository when cloning, default: 50. Specifying a smaller number can decrease the default fetching time
FCI_PROJECT_IDUUID of the project that is being built
FCI_BUILD_IDUUID of the build
FCI_TEST_STEP_STATUSTest step status, success or failure
FCI_BUILD_STEP_STATUSBuild step status, success, failure or skipped. Only available when using Workflow Editor, unavailable with codemagic.yaml
FCI_BUILD_DIRAbsolute path to the root directory of the cloned repository in Codemagic builders
FCI_BUILD_OUTPUT_DIRContains the artifact files generated during the build
FCI_EXPORT_DIRThe files added to this directory will be added to a zip file and made available as build artifacts
FCI_FLUTTER_SCHEMEName of the iOS scheme to be used
FCI_SYMROOTDirectory path of files generated during Xcode build
FCI_KEYSTORE_PASSWORDPassword of Android keystore as configured in the UI
FCI_KEY_PASSWORDPassword of Android key as configured in the UI
FCI_KEY_ALIASAlias of the key as configured in the UI
FCI_KEYSTORE_PATHPath of the file in our VM
FCI_ARTIFACT_LINKSInformation about generated build artifacts that is available in post-publishing step. Read more about it below.

$FCI_ARTIFACT_LINKS environment variable value is a JSON encoded list in the following form:

[
  {
    "name": "Codemagic_Release.ipa",
    "type": "ipa",
    "url": "https://api.codemagic.io/artifacts/2e7564b2-9ffa-40c2-b9e0-8980436ac717/81c5a723-b162-488a-854e-3f5f7fdfb22f/Codemagic_Release.ipa",
    "md5": "d2884be6985dad3ffc4d6f85b3a3642a",
    "versionName": "1.0.2",
    "bundleId": "io.codemagic.app"
  }
]