Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updated and refined documentation #2760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 27, 2024
Merged

Updated and refined documentation #2760

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b744f86
Cleared usage of identification properties
cmaglie Nov 20, 2024
bd3c784
Expanded docs on default directories configuration
cmaglie Nov 21, 2024
dbd2498
Refined platform specification on installation folder for platforms
cmaglie Nov 21, 2024
195977b
Apply suggestions from code review
cmaglie Nov 21, 2024
ddaf0a0
Use real platforms in example
cmaglie Nov 25, 2024
ab0cbe4
Apply code review suggestions
cmaglie Nov 27, 2024
f250df9
Fixed doc formatting, after upgrade of 'prettier'
cmaglie Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Expanded docs on default directories configuration
  • Loading branch information
@cmaglie
cmaglie committed Nov 21, 2024
commit bd3c7848b24b19fe311a76ae4b01dd3c6629a042
22 changes: 21 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
- `data` - directory used to store Boards/Library Manager index files and Boards Manager platform installations.
- `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.
installations are made to the `libraries` subdirectory of the user directory. Users can manually install 3rd party
platforms in the `hardware` subdirecotry of the user directory.
- `builtin.libraries` - the libraries in this directory will be available to all platforms without the need for the
user to install them, but with the lowest priority over other installed libraries with the same name, it's the
equivalent of the Arduino IDE's bundled libraries directory.
Expand Down Expand Up @@ -45,6 +46,25 @@
- `network` - configuration options related to the network connection.
- `proxy` - URL of the proxy server.

### Default directories

The following are the default directories selected by the Arduino CLI if alternatives are not specified in the
configuration file.

- The `directories.data` default is OS-dependent:

- on Linux (and other Unix-based OS) is: `{HOME}/.arduino15`
- on Windows is: `{HOME}/AppData/Local/Arduino15`
- on MacOS is: `{HOME}/Library/Arduino15`

- The `directories.download` default is `{directories.data}/staging`. If the value of `{directories.data}` is changed in
the configuration the user-specified value will be used.

- The `directories.user` default is OS-dependent:
- on Linux (and other Unix-based OS) is: `{HOME}/Arduino`
- on Windows is: `{DOCUMENTS}/Arduino`
- on MacOS is: `{HOME}/Documents/Arduino`

## Configuration methods

Arduino CLI may be configured in three ways:
Expand Down