.. _envvars:

Environment variables
=====================

`Environment variables <http://en.wikipedia.org/wiki/Environment_variable>`_
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**.

.. contents::

General
-------

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

.. _envvar_PLATFORMIO_HOME_DIR:

PLATFORMIO_HOME_DIR
~~~~~~~~~~~~~~~~~~~

Allows to override :ref:`projectconf` option
:ref:`projectconf_pio_home_dir`.

.. _envvar_PLATFORMIO_LIB_DIR:

PLATFORMIO_LIB_DIR
~~~~~~~~~~~~~~~~~~

Allows to override :ref:`projectconf` option
:ref:`projectconf_pio_lib_dir`.

.. _envvar_PLATFORMIO_SRC_DIR:

PLATFORMIO_SRC_DIR
~~~~~~~~~~~~~~~~~~

Allows to override :ref:`projectconf` option
:ref:`projectconf_pio_src_dir`.

.. _envvar_PLATFORMIO_ENVS_DIR:

PLATFORMIO_ENVS_DIR
~~~~~~~~~~~~~~~~~~~

Allows to override :ref:`projectconf` option
:ref:`projectconf_pio_envs_dir`.


Builder
-------

.. _envvar_PLATFORMIO_SRCBUILD_FLAGS:

PLATFORMIO_SRCBUILD_FLAGS
~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override :ref:`projectconf` option
:ref:`projectconf_srcbuild_flags`.

Settings
--------

Allows to override PlatformIO settings. You can manage them via
:ref:`cmd_settings` command.


PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`auto_update_libraries`.

PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`auto_update_platforms`.

PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`check_libraries_interval`.

PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`check_platformio_interval`.

PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`check_platforms_interval`.

.. _envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS:

PLATFORMIO_SETTING_ENABLE_PROMPTS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`enable_prompts`.

PLATFORMIO_SETTING_ENABLE_TELEMETRY
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows to override setting :option:`enable_telemetry`.