forked from platformio/platformio-core
115 lines
2.9 KiB
ReStructuredText
115 lines
2.9 KiB
ReStructuredText
|
.. _cmd_settings:
|
||
|
|
|
||
|
|
platformio settings
|
||
|
|
===================
|
||
|
|
|
||
|
|
Manage PlatformIO settings
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
platformio settings get
|
||
|
|
-----------------------
|
||
|
|
|
||
|
|
Usage
|
||
|
|
~~~~~
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
platformio settings get [NAME]
|
||
|
|
|
||
|
|
|
||
|
|
Description
|
||
|
|
~~~~~~~~~~~
|
||
|
|
|
||
|
|
Get/List existing settings
|
||
|
|
|
||
|
|
|
||
|
|
Examples
|
||
|
|
~~~~~~~~
|
||
|
|
|
||
|
|
1. List all settings and current their values
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ platformio settings get
|
||
|
|
Name Value [Default] Description
|
||
|
|
------------------------------------------------------------------------------------------
|
||
|
|
auto_update_libraries Yes Automatically update libraries (Yes/No)
|
||
|
|
auto_update_platforms Yes Automatically update platforms (Yes/No)
|
||
|
|
check_libraries_interval 7 Check for the library updates interval (days)
|
||
|
|
check_platformio_interval 3 Check for the new PlatformIO interval (days)
|
||
|
|
check_platforms_interval 7 Check for the platforms updates interval (days)
|
||
|
|
|
||
|
|
|
||
|
|
2. Show specified setting
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ platformio settings get auto_update_platforms
|
||
|
|
Name Value [Default] Description
|
||
|
|
------------------------------------------------------------------------------------------
|
||
|
|
auto_update_platforms Yes Automatically update platforms (Yes/No)
|
||
|
|
|
||
|
|
|
||
|
|
platformio settings set
|
||
|
|
-----------------------
|
||
|
|
|
||
|
|
Usage
|
||
|
|
~~~~~
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
platformio settings set NAME VALUE
|
||
|
|
|
||
|
|
|
||
|
|
Description
|
||
|
|
~~~~~~~~~~~
|
||
|
|
|
||
|
|
Set new value for the setting
|
||
|
|
|
||
|
|
Examples
|
||
|
|
~~~~~~~~
|
||
|
|
|
||
|
|
Change to check for the new PlatformIO each day
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ platformio settings set check_platformio_interval 1
|
||
|
|
The new value for the setting has been set!
|
||
|
|
Name Value [Default] Description
|
||
|
|
------------------------------------------------------------------------------------------
|
||
|
|
check_platformio_interval 1 [3] Check for the new PlatformIO interval (days)
|
||
|
|
|
||
|
|
|
||
|
|
platformio settings reset
|
||
|
|
-------------------------
|
||
|
|
|
||
|
|
Usage
|
||
|
|
~~~~~
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
platformio settings reset
|
||
|
|
|
||
|
|
|
||
|
|
Description
|
||
|
|
~~~~~~~~~~~
|
||
|
|
|
||
|
|
Reset settings to default
|
||
|
|
|
||
|
|
Examples
|
||
|
|
~~~~~~~~
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ platformio settings reset
|
||
|
|
The settings have been reseted!
|
||
|
|
|
||
|
|
Name Value [Default] Description
|
||
|
|
------------------------------------------------------------------------------------------
|
||
|
|
auto_update_libraries Yes Automatically update libraries (Yes/No)
|
||
|
|
auto_update_platforms Yes Automatically update platforms (Yes/No)
|
||
|
|
check_libraries_interval 7 Check for the library updates interval (days)
|
||
|
|
check_platformio_interval 3 Check for the new PlatformIO interval (days)
|
||
|
|
check_platforms_interval 7 Check for the platform updates interval (days)
|