Skip to content

Commit 9ee4fd8

Browse files
authored
[skip changelog] Document library.enable_unsafe_install configuration key (#1087)
1 parent b22aa6f commit 9ee4fd8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: docs/configuration.md

+5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
- `downloads` - directory used to stage downloaded archives during Boards/Library Manager installations.
1010
- `user` - the equivalent of the Arduino IDE's ["sketchbook" directory][sketchbook directory]. Library Manager
1111
installations are made to the `libraries` subdirectory of the user directory.
12+
- `library` - configuration options relating to Arduino libraries.
13+
- `enable_unsafe_install` - set to `true` to enable the use of the `--git-url` and `--zip-file` flags with
14+
[`arduino-cli lib install`][arduino cli lib install]. These are considered "unsafe" installation methods because
15+
they allow installing files that have not passed through the Library Manager submission process.
1216
- `logging` - configuration options for Arduino CLI's logs.
1317
- `file` - path to the file where logs will be written.
1418
- `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
126130

127131
[grpc]: https://grpc.io
128132
[sketchbook directory]: sketch-specification.md#sketchbook
133+
[arduino cli lib install]: commands/arduino-cli_lib_install.md
129134
[arduino-cli config dump]: commands/arduino-cli_config_dump.md
130135
[arduino cli command reference]: commands/arduino-cli.md
131136
[arduino-cli global flags]: commands/arduino-cli_config.md#options-inherited-from-parent-commands

0 commit comments

Comments
 (0)