Skip to content

Commit bd3c784

Browse files
committed
Expanded docs on default directories configuration
1 parent b744f86 commit bd3c784

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/configuration.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
- `data` - directory used to store Boards/Library Manager index files and Boards Manager platform installations.
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
11-
installations are made to the `libraries` subdirectory of the user directory.
11+
installations are made to the `libraries` subdirectory of the user directory. Users can manually install 3rd party
12+
platforms in the `hardware` subdirecotry of the user directory.
1213
- `builtin.libraries` - the libraries in this directory will be available to all platforms without the need for the
1314
user to install them, but with the lowest priority over other installed libraries with the same name, it's the
1415
equivalent of the Arduino IDE's bundled libraries directory.
@@ -45,6 +46,25 @@
4546
- `network` - configuration options related to the network connection.
4647
- `proxy` - URL of the proxy server.
4748

49+
### Default directories
50+
51+
The following are the default directories selected by the Arduino CLI if alternatives are not specified in the
52+
configuration file.
53+
54+
- The `directories.data` default is OS-dependent:
55+
56+
- on Linux (and other Unix-based OS) is: `{HOME}/.arduino15`
57+
- on Windows is: `{HOME}/AppData/Local/Arduino15`
58+
- on MacOS is: `{HOME}/Library/Arduino15`
59+
60+
- The `directories.download` default is `{directories.data}/staging`. If the value of `{directories.data}` is changed in
61+
the configuration the user-specified value will be used.
62+
63+
- The `directories.user` default is OS-dependent:
64+
- on Linux (and other Unix-based OS) is: `{HOME}/Arduino`
65+
- on Windows is: `{DOCUMENTS}/Arduino`
66+
- on MacOS is: `{HOME}/Documents/Arduino`
67+
4868
## Configuration methods
4969

5070
Arduino CLI may be configured in three ways:

0 commit comments

Comments
 (0)