From ed18b865e2780396a6f7b828c57c2434c53ffae6 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 30 Nov 2020 04:02:42 -0800 Subject: [PATCH] [skip changelog] Document `library.enable_unsafe_install` configuration key --- docs/configuration.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index b8236f0a7b6..2b1e67c6a81 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -9,6 +9,10 @@ - `downloads` - directory used to stage downloaded archives during Boards/Library Manager installations. - `user` - the equivalent of the Arduino IDE's ["sketchbook" directory][sketchbook directory]. Library Manager installations are made to the `libraries` subdirectory of the user directory. +- `library` - configuration options relating to Arduino libraries. + - `enable_unsafe_install` - set to `true` to enable the use of the `--git-url` and `--zip-file` flags with + [`arduino-cli lib install`][arduino cli lib install]. These are considered "unsafe" installation methods because + they allow installing files that have not passed through the Library Manager submission process. - `logging` - configuration options for Arduino CLI's logs. - `file` - path to the file where logs will be written. - `format` - output format for the logs. Allowed values are `text` or `json`. @@ -126,6 +130,7 @@ additional_urls = [ "https://downloads.arduino.cc/packages/package_staging_index [grpc]: https://grpc.io [sketchbook directory]: sketch-specification.md#sketchbook +[arduino cli lib install]: commands/arduino-cli_lib_install.md [arduino-cli config dump]: commands/arduino-cli_config_dump.md [arduino cli command reference]: commands/arduino-cli.md [arduino-cli global flags]: commands/arduino-cli_config.md#options-inherited-from-parent-commands