Subcommands49 subcommands
arduino-cli board
Arduino board commands
arduino-cli board attach
Sets the default values for port and FQBN. If no port or FQBN are specified, the current default port and FQBN are displayed
arduino-cli board details
Show information about a board, in particular if the board has options to be specified in the FQBN'
arduino-cli board list
Detects and displays a list of boards connected to the current computer
arduino-cli board listall
List all boards that have the support platform installed, You can search for a specific board if you specify the board name
arduino-cli board search
Search for a board in the Boards Manager using the specified keywords
arduino-cli burn-bootloader
Upload the bootloader on the board using an external programmer
arduino-cli cache
Arduino cache commands
arduino-cli cache clean
Delete contents of the directories.downloads folder, where archive files are staged during installation of libraries and boards platforms
arduino-cli compile
Compiles Arduino sketches
arduino-cli completion
Generates completion scripts for various shells
arduino-cli config
Arduino configuration commands
arduino-cli config add
Adds one or more values to a setting
arduino-cli config delete
Deletes a settings key and all its sub keys
arduino-cli config dump
Prints the current configuration
arduino-cli config init
Creates or updates the configuration file in the data directory or custom directory with the current configuration settings
arduino-cli config remove
Removes one or more values from a setting
arduino-cli config set
Sets a setting value
arduino-cli core
Arduino core operations
arduino-cli core download
Downloads one or more cores and corresponding tool dependencies
arduino-cli core install
Installs one or more cores and corresponding tool dependencies
arduino-cli core list
Show the list of installed platforms
arduino-cli core search
Search for a core in Boards Manager using the specified keywords
arduino-cli core uninstall
Uninstalls one or more cores and corresponding tool dependencies if no longer used
arduino-cli core update-index
Updates the index of cores to the latest version
arduino-cli core upgrade
Upgrades one or all installed platforms to the latest version
arduino-cli daemon
Run as a daemon on port: 50051, the initialization of cores and libraries is done only once
arduino-cli debug
Debug Arduino sketches. (this command opens an interactive gdb session)
arduino-cli debug check
Check if the given board/programmer combination supports debugging
arduino-cli help
Help provides help for any command in the application
arduino-cli lib
Arduino commands about libraries
arduino-cli lib deps
Check dependencies status for the specified library
arduino-cli lib download
Downloads one or more libraries without installing them
arduino-cli lib examples
Shows the list of the examples for libraries. A name may be given as argument to search a specific library
arduino-cli lib install
Installs one or more specified libraries into the system
arduino-cli lib list
Shows a list of installed libraries. If the LIBNAME parameter is specified the listing is limited to that specific library. By default the libraries provided as built-in by platforms/core are not listed, they can be listed by adding the --all flag
arduino-cli lib search
Search for one or more libraries data (case insensitive search)
arduino-cli lib uninstall
Uninstalls one or more libraries
arduino-cli lib update-index
Updates the libraries index to the latest version
arduino-cli lib upgrade
Upgrades installed libraries. This command upgrades an installed library to the latest available version. Multiple libraries can be passed separated by a space. If no arguments are provided, the command will upgrade all the installed libraries where an update is available
arduino-cli monitor
Open a communication port with a board
arduino-cli outdated
This commands shows a list of installed cores and/or libraries that can be upgraded. If nothing needs to be updated the output is empty
arduino-cli sketch
Arduino CLI sketch commands
arduino-cli sketch archive
Creates a zip file containing all sketch files
arduino-cli sketch new
Create a new Sketch
arduino-cli update
Updates the index of cores and libraries to the latest versions
arduino-cli upgrade
Upgrades installed cores and libraries to latest version
arduino-cli upload
Upload Arduino sketches. This does NOT compile the sketch prior to upload
arduino-cli version
Shows the version number of Arduino CLI which is installed on your system
OptionsOn arduino-cli itself
--additional-urls
Comma-separated list of additional URLs for the Boards Manager <value>
--config-file
The custom config file (if not specified the default will be used) <file>
--format
The output format for the logs, can be: text, json, jsonmini, yaml (default 'text') <data_format>
-h--help
Help for arduino-cli
--log
Print the logs on the standard output
--log-file
Path to the file where logs will be written <filepath>
--log-format
The output format for the logs, can be: text, json <format>
--log-level
Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic <level>
--no-color
Disable colored output
