Creating config file + examples

Configuration keys

board_manager

• additional_urls: the URLs to any additional Boards Manager package index files needed for your boards platforms.
• enable_unsafe_install: set to true to allow installation of packages that do not pass the checksum test. This is considered an unsafe installation method and should be used only for development purposes.

daemon

• port: TCP port used for gRPC client connections.

directories

• 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: equivalent of the Arduino IDE's “sketchbook” directory. Library Manager installs to user/libraries. 3rd-party platforms can be put in user/hardware.
• builtin.libraries: these libraries are available to all platforms with the lowest priority; equivalent to the Arduino IDE’s bundled libraries.

library

• enable_unsafe_install: set to true to enable use of --git-url and --zip-file with arduino-cli lib install.

locale

• language: POSIX language identifier (e.g., it, it_IT.UTF-8).

logging

• file: path to the log file.
• format: text or json.
• level: log level: trace, debug, info, warn, error, fatal, panic.

metrics

• addr: TCP port used for metrics.
• enabled: controls whether metrics are enabled.

output

• no_color: set to true to disable ANSI colors.

sketch

• always_export_binaries: set to true to always export binaries (same as --export-binaries).

updater

• enable_notification: false disables update notifications.

build_cache

• path: directory where build caches are stored.
• extra_paths: additional paths to search for precompiled artifacts.
• compilations_before_purge: number of compilations before cache purge (default 10; 0 = never purge).
• ttl: expiration time for cached build folders (default 720h).

network

• proxy: URL of proxy server.
• connection_timeout: timeout in time.ParseDuration format (default 60s; 0 = no limit).
• cloud_api.skip_board_detection_calls: if true, skips network calls to Arduino Cloud during board detection.

Default directories

• build_cache.path: OS-dependent default:
  • Linux: $XDG_CACHE_HOME/arduino or ~/.config/arduino
  • Windows: %USERPROFILE%/AppData/Local/arduino
  • macOS: ~/Library/Caches/arduino
• directories.data:
  • Linux: ~/.arduino15
  • Windows: %LOCALAPPDATA%/Arduino15
  • macOS: ~/Library/Arduino15
• directories.downloads: default is {directories.data}/staging.
• directories.user:
  • Linux: ~/Arduino
  • Windows: %USERPROFILE%/Documents/Arduino
  • macOS: ~/Documents/Arduino

Configuration methods

• Command line flags
• Environment variables
• Configuration file

If a value is set by multiple methods, the highest priority wins. Unset values use defaults.

arduino-cli config dump shows all current configuration values.

Config example:

board_manager:
  additional_urls: []
  enable_unsafe_install: false

daemon:
  port: 50051

directories:
  data: ""
  downloads: ""
  user: ""
  builtin:
    libraries: ""

library:
  enable_unsafe_install: false

locale: "en_US"

logging:
  file: ""
  format: text
  level: info

metrics:
  addr: ":9090"
  enabled: true

output:
  no_color: false

sketch:
  always_export_binaries: false

updater:
  enable_notification: true

build_cache:
  path: ""
  extra_paths: []
  compilations_before_purge: 10
  ttl: "720h"

network:
  proxy: ""
  connection_timeout: "60s"
  cloud_api:
    skip_board_detection_calls: false