Environment variables¶

Environment variables are a set of dynamic named values that can affect the way running processes will behave on a computer.

PlatformIO handles variables which start with PLATFORMIO_ prefix. They have the HIGHEST PRIORITY.

How to set environment variable?

# Windows
set VARIABLE_NAME=VALUE

# Unix (bash, zsh)
export VARIABLE_NAME=VALUE

# Unix (fish)
set -x VARIABLE_NAME VALUE

General ¶

PlatformIO uses General environment variables for the common operations/commands.

CI¶

PlatformIO handles CI variable which is setup by Continuous Integration (Travis, Circle and etc.) systems. PlatformIO uses it to disable prompts and progress bars. In other words, CI=true automatically setup PLATFORMIO_DISABLE_PROGRESSBAR to true.

PLATFORMIO_AUTH_TOKEN¶

Allows to specify Personal Authentication Token that could be used for automatic login in to PIO Account. It is very useful for Continuous Integration systems and PIO Remote operations where you are not able manually authorize.

You can get own Personal Authentication Token using platformio account token command.

PLATFORMIO_FORCE_COLOR¶

Force to output color ANSI-codes even if the output is a pipe (not a tty). The possible values are true and false. Default is PLATFORMIO_FORCE_COLOR=false.

PLATFORMIO_DISABLE_PROGRESSBAR¶

Disable progress bar for package/library downloader and uploader. This is useful when calling PlatformIO from subprocess and output is a pipe (not a tty). The possible values are true and false. Default is PLATFORMIO_DISABLE_PROGRESSBAR=false.

PLATFORMIO_HOME_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option home_dir.

PLATFORMIO_INCLUDE_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option include_dir.

PLATFORMIO_SRC_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option src_dir.

PLATFORMIO_LIB_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option lib_dir.

PLATFORMIO_LIBDEPS_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option libdeps_dir.

PLATFORMIO_BUILD_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option build_dir.

PLATFORMIO_DATA_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option data_dir.

PLATFORMIO_TEST_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option test_dir.

PLATFORMIO_BOARDS_DIR¶

Allows to override “platformio.ini” (Project Configuration File) option boards_dir.

PLATFORMIO_REMOTE_AGENT_DIR¶

Allows to override platformio remote agent start --working-dir.

Building ¶

PLATFORMIO_BUILD_FLAGS¶

Allows to set “platformio.ini” (Project Configuration File) option build_flags.

Examples:

# Unix:
export PLATFORMIO_BUILD_FLAGS=-DFOO
export PLATFORMIO_BUILD_FLAGS=-DFOO -DBAR=1 -DFLOAT_VALUE=1.23457e+07
export PLATFORMIO_BUILD_FLAGS='-DWIFI_PASS=\"My password\"' '-DWIFI_SSID=\"My ssid name\"'

# Windows:
SET PLATFORMIO_BUILD_FLAGS=-DFOO
SET PLATFORMIO_BUILD_FLAGS=-DFOO -DBAR=1 -DFLOAT_VALUE=1.23457e+07
SET PLATFORMIO_BUILD_FLAGS='-DWIFI_PASS="My password"' '-DWIFI_SSID="My ssid name"'