pio-settings

Display the names, values and descriptions of all PlatformIO settings

$ pio settings get

$ pio settings get [setting]

$ pio settings set [setting] [value]

$ pio settings reset

pio settings <get|set|reset> <setting_name> <value>

get <setting_name>
    Retrieve the value of a specific setting. Example: pio settings get auto_upload

set <setting_name> <value>
    Set the value of a specific setting. Example: pio settings set auto_upload true

reset <setting_name>
    Reset a specific setting to its default value. Example: pio settings reset auto_upload

The `pio settings` command allows you to manage PlatformIO IDE's configuration directly from the command line. This is especially useful for automation, scripting, and configuring PlatformIO in headless environments or CI/CD pipelines. It provides a way to read, write, and reset PlatformIO settings without requiring a graphical interface. These settings can control various aspects of the PlatformIO IDE, such as default boards, frameworks, library directories, and more. Using `pio settings`, one can ensure a consistent configuration across different development environments, simplifying project setup and troubleshooting.

The specific settings available and their possible values depend on the PlatformIO IDE version and installed extensions. Use `pio settings get` without arguments to list all possible parameters.

To view the value of the 'auto_upload' setting:
pio settings get auto_upload

To enable automatic uploads:
pio settings set auto_upload true

The `pio settings` command primarily interacts with the configuration files used by the PlatformIO IDE. Modifying these settings affects how the IDE behaves.

pio(1), pio project(1), pio run(1)