Environment variables

Environment variables are useful for storing information that you do not want to store in the repository, such as your credentials or workflow-specific data. In addition, you can make use of a number of read-only environment variables that Codemagic exports to customize your builds.

Codemagic read-only environment variables

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:

set -ex

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

Environment variableValue
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 destination branch
FCI_COMMITCommit hash that is currently being built by Codemagic, for pull request builds it is the hash of the source commit
FCI_CLONE_UNSHALLOWIf set to true, performs a full clone of the repository instead of top 50 commits
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
FCI_BUILD_DIRAbsolute path to 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"

Using environment variables

To access a variable, add the $ symbol in front of its name. For example, access API_TOKEN by using $API_TOKEN. Note that it is required to use quotation marks with multi-line variables when you are referencing them in custom scripts, as shown in the example below:

> MY_VAR="var
> value"
> echo $MY_VAR
< var value
> echo "$MY_VAR"
< var
< value

Adding environment variables to Flutter projects via UI

Flutter projects can be configured both in .yaml file as well as in the Codemagic web app graphical user interface. You can add environment variables to your Flutter projects in App settings > Environment variables.

  1. Enter the name and the value of the variable.
  2. Check Secure if you wish to hide the value both in the UI and in build logs and disable editing of the variable. Such variables can be accessed only by the build machines during the build.
  3. Click Add.
  4. Click Save to save the settings.