pio settings ¶

Manage PIO settings

Contents

pio settings get ¶

Usage ¶

pio settings get [NAME]

Description ¶

Note

The Yes value is equal to: True, Y, 1 and is not case sensitive.
You can override these settings using Environment variables.

Get/List existing settings

Settings ¶

`check_platformio_interval`¶

Default: 7
Values: Days (Number)

An interval for checking for the new version of PIO Core.

`check_prune_system_threshold`¶

Default: 1024
Values: Megabytes (Number)

Check for pruning unnecessary data threshold (megabytes). You can list unnecessary PIO system data using pio system prune --dry-run command. See pio system prune for the other options.

Do disable checking for unnecessary data, please set threshold to 0 using pio settings set command.

`enable_cache`¶

Default: Yes
Values: Yes/No

Enable caching for Package Manager and for API requests.

`force_verbose`¶

Default: No
Values: Yes/No

Force verbose output when processing environments. This setting overrides

`projects_dir`¶

Default: ~/Documents/PIO/Projects
Values: Path to folder

Default location for PIO projects (PIO Home).

`enable_proxy_strict_ssl`¶

Default: Yes
Values: Yes/No

Verify the proxy server certificate against the list of supplied CAs. See also PIO Core Proxy Configuration.

`enable_telemetry`¶

Default: Yes
Values: Yes/No

Share minimal diagnostics and usage information to help us make PIO better.

The source code of telemetry service is open source. You can make sure that we DO NOT SHARE PRIVATE information or source code of your project. All information shares ANONYMOUSLY.

Which data do we collect and why?

A version of Python Interpreter. PIO Core (CLI) is written in Python language, including development Platforms. We need to know which Python version produces such type of exceptions (see below), which is more popular, which version we should drop and focus on a new one
PIO Core (CLI) errors/exceptions. We report automatically fatal exceptions raised by PIO Core source code but NOT by your project
The name of the used platform, board, framework. We collect this type of information to have a clear picture which software products are the most widely used by our Community and for the which we should provide frequent updates and add new features ( for example, “atmelavr”, “arduino”, “uno”, etc.)
The name of CLI command. It helps us to improve our CLI. For example, “run”, “lib list”)
The name of Cloud & Desktop IDEs. This is very important information for us. We create native extensions based on the popularity of IDEs (for example, PIO IDE for VSCode)

Thanks a lot that you keep this setting enabled!

Examples ¶

List all settings and theirs current values

> pio settings get

Name                            Value [Default]   Description
------------------------------------------------------------------------------------------
check_platformio_interval       7                 Check for the new PIO Core interval (days)
check_prune_system_threshold    1024              Check for pruning unnecessary data threshold (megabytes)
enable_cache                    Yes               Enable caching for HTTP API requests
enable_telemetry                Yes               Telemetry service <https://bit.ly/pio-telemetry> (Yes/No)
force_verbose                   No                Force verbose output when processing environments
projects_dir                    ~/Documents/PIO/Projects Default location for PIO projects (PIO Home)

Show specified setting

> pio settings get check_prune_system_threshold
Name                            Value [Default]   Description
------------------------------------------------------------------------------------------
check_prune_system_threshold    1024              Check for pruning unnecessary data threshold (megabytes)

pio settings set ¶

Usage ¶

pio settings set NAME VALUE

Description ¶

Set new value for the setting

Examples ¶

Change to check for the new PIO Core each day

> pio settings set check_platformio_interval 1
The new value for the setting has been set!
Name                            Value [Default]   Description
------------------------------------------------------------------------------------------
check_platformio_interval       1 [7]             Check for the new PIO interval (days)

pio settings reset ¶

Usage ¶

pio settings reset

Description ¶

Reset settings to default

Examples ¶

> pio settings reset
The settings have been reset!

Name                            Value [Default]   Description
------------------------------------------------------------------------------------------
check_platformio_interval       7                 Check for the new PIO Core interval (days)
check_prune_system_threshold    1024              Check for pruning unnecessary data threshold (megabytes)
enable_cache                    Yes               Enable caching for HTTP API requests
enable_telemetry                Yes               Telemetry service <https://bit.ly/pio-telemetry> (Yes/No)
force_verbose                   No                Force verbose output when processing environments
projects_dir                    ~/Documents/PIO/Projects Default location for PIO projects (PIO Home)