mirror of
https://github.com/platformio/platformio-core.git
synced 2025-10-04 17:40:57 +02:00
130 lines
3.1 KiB
ReStructuredText
130 lines
3.1 KiB
ReStructuredText
.. _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_CI:
|
|
|
|
CI
|
|
~~
|
|
|
|
PlatformIO handles ``CI`` variable which is setup by
|
|
`Continuous Integration <http://en.wikipedia.org/wiki/Continuous_integration>`_
|
|
(Travis, Circle and etc.) systems.
|
|
Currently, PlatformIO uses it to disable prompts.
|
|
|
|
In other words, ``CI=true`` automatically setup
|
|
:ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=false <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`.
|
|
|
|
.. _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_BUILD_FLAGS:
|
|
|
|
PLATFORMIO_BUILD_FLAGS
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_build_flags`.
|
|
|
|
.. _envvar_PLATFORMIO_SRCBUILD_FLAGS:
|
|
|
|
PLATFORMIO_SRCBUILD_FLAGS
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_srcbuild_flags`.
|
|
|
|
.. _envvar_PLATFORMIO_LDF_CYCLIC:
|
|
|
|
PLATFORMIO_LDF_CYCLIC
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_ldf_cyclic`.
|
|
|
|
Settings
|
|
--------
|
|
|
|
Allows to override PlatformIO settings. You can manage them via
|
|
:ref:`cmd_settings` command.
|
|
|
|
|
|
PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_auto_update_libraries`.
|
|
|
|
PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_auto_update_platforms`.
|
|
|
|
PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_check_libraries_interval`.
|
|
|
|
PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_check_platformio_interval`.
|
|
|
|
PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_check_platforms_interval`.
|
|
|
|
.. _envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS:
|
|
|
|
PLATFORMIO_SETTING_ENABLE_PROMPTS
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_enable_prompts`.
|
|
|
|
PLATFORMIO_SETTING_ENABLE_TELEMETRY
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Allows to override setting :ref:`setting_enable_telemetry`.
|