Commit 72e05eeb authored by Cristian Maglie's avatar Cristian Maglie

Updated documentation about configuration file format

parent fa835de3
...@@ -4,6 +4,10 @@ Here you can find a list of migration guides to handle breaking changes between ...@@ -4,6 +4,10 @@ Here you can find a list of migration guides to handle breaking changes between
## 0.36.0 ## 0.36.0
### Configuration file now supports only YAML format.
The Arduino CLI configuration file now supports only the YAML format.
### gRPC Setting API important changes ### gRPC Setting API important changes
The Settings API has been heavily refactored. Here a quick recap of the new methods: The Settings API has been heavily refactored. Here a quick recap of the new methods:
......
...@@ -97,8 +97,7 @@ $ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS="https://downloads.arduino.cc/pac ...@@ -97,8 +97,7 @@ $ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS="https://downloads.arduino.cc/pac
### Configuration file ### Configuration file
[`arduino-cli config init`][arduino-cli config init] creates or updates a configuration file with the current [`arduino-cli config init`][arduino-cli config init] creates a new empty configuration file.
configuration settings.
This allows saving the options set by command line flags or environment variables. For example: This allows saving the options set by command line flags or environment variables. For example:
...@@ -106,29 +105,14 @@ This allows saving the options set by command line flags or environment variable ...@@ -106,29 +105,14 @@ This allows saving the options set by command line flags or environment variable
arduino-cli config init --additional-urls https://downloads.arduino.cc/packages/package_staging_index.json arduino-cli config init --additional-urls https://downloads.arduino.cc/packages/package_staging_index.json
``` ```
#### File name
The configuration file must be named `arduino-cli`, with the appropriate file extension for the file's format.
#### Supported formats
`arduino-cli config init` creates a YAML file, however a variety of common formats are supported:
- [JSON]
- [TOML]
- [YAML]
- [Java properties file]
- [HCL]
- envfile
- [INI]
#### Locations #### Locations
Configuration files in the following locations are recognized by Arduino CLI: The default configuration file is named `arduino-cli.yaml`. The configuration file is searched in the following
locations, in order of priority:
1. Location specified by the [`--config-file`][arduino cli command reference] command line flag 1. Location specified by the [`--config-file`][arduino cli command reference] command line flag
1. Location specified by the `ARDUINO_CONFIG_FILE` environment variable 1. Location specified by the `ARDUINO_CONFIG_FILE` environment variable
1. Arduino CLI data directory (as configured by `directories.data`) 1. Location specified by the `ARDUINO_DIRECTORIES_DATA` environment variable
If multiple configuration files are present, the one highest on the above list is used. Configuration files are not If multiple configuration files are present, the one highest on the above list is used. Configuration files are not
combined. combined.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment