Table of Contents

• How to contribute
• How to install
  • Get the latest version
  • Get a nightly build
  • Build from source
• How to use
  • Create a configuration file
  • Create a new sketch
  • Connect the board to your PC
  • Install the core for your board
  • Compile and upload the sketch
  • Add libraries
• Getting help
• Troubleshooting
• Using the gRPC interface

How to contribute

How to install

Get the latest version

Install via Homebrew (macOS/Linux)

brew updatebrew install arduino-cli

Use the install script

curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh

curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/local/bin sh

Download the latest packages

Get a nightly build

Build from source

docker run -v $PWD:/arduino-cli -w /arduino-cli -e PACKAGE_NAME_PREFIX='snapshot' arduino/arduino-cli:builder-1 goreleaser --rm-dist --snapshot --skip-publish

How to use

Create a configuration file

$arduino-cli config initConfig file written: /home/luca/.arduino15/arduino-cli.yaml

Create a new sketch

$arduino-cli sketch new MyFirstSketchSketch created in: /home/luca/MyFirstSketch

$cat$HOME/MyFirstSketch/MyFirstSketch.inovoid setup() {}void loop() {}

voidsetup() {pinMode(LED_BUILTIN,OUTPUT);}voidloop() {digitalWrite(LED_BUILTIN,HIGH);delay(1000);digitalWrite(LED_BUILTIN,LOW);delay(1000);}

Connect the board to your PC

$arduino-cli core update-indexUpdating index: package_index.json downloaded

$arduino-cli board listPort         Type              Board Name              FQBN                 Core/dev/ttyACM1 Serial Port (USB) Arduino/Genuino MKR1000 arduino:samd:mkr1000 arduino:samd

$arduino-cli board listall mkrBoard Name              FQBNArduino MKR FOX 1200    arduino:samd:mkrfox1200Arduino MKR GSM 1400    arduino:samd:mkrgsm1400Arduino MKR WAN 1300    arduino:samd:mkrwan1300Arduino MKR WiFi 1010   arduino:samd:mkrwifi1010Arduino MKRZERO         arduino:samd:mkrzeroArduino/Genuino MKR1000 arduino:samd:mkr1000

Install the core for your board

$arduino-cli core install arduino:samdDownloading tools...arduino:arm-none-eabi-gcc@4.8.3-2014q1 downloadedarduino:bossac@1.7.0 downloadedarduino:openocd@0.9.0-arduino6-static downloadedarduino:CMSIS@4.5.0 downloadedarduino:CMSIS-Atmel@1.1.0 downloadedarduino:arduinoOTA@1.2.0 downloadedDownloading cores...arduino:samd@1.6.19 downloadedInstalling tools...Installing platforms...Results:arduino:samd@1.6.19 - Installedarduino:arm-none-eabi-gcc@4.8.3-2014q1 - Installedarduino:bossac@1.7.0 - Installedarduino:openocd@0.9.0-arduino6-static - Installedarduino:CMSIS@4.5.0 - Installedarduino:CMSIS-Atmel@1.1.0 - Installedarduino:arduinoOTA@1.2.0 - Installed

$arduino-cli core listID              Installed       Latest  Namearduino:samd    1.6.19          1.6.19  Arduino SAMD Boards (32-bits ARM Cortex-M0+)

Adding 3rd party cores

board_manager:additional_urls:    -https://arduino.esp8266.com/stable/package_esp8266com_index.json

$arduino-cli core update-indexUpdating index: package_index.json downloadedUpdating index: package_esp8266com_index.json downloadedUpdating index: package_index.json downloaded$arduino-cli core search esp8266ID              Version Nameesp8266:esp8266 2.5.2   esp8266

$arduino-cli  core update-index --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.jsonUpdating index: package_esp8266com_index.json downloaded$arduino-cli core search esp8266 --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.jsonID              Version Nameesp8266:esp8266 2.5.2   esp8266

Compile and upload the sketch

$arduino-cli compile --fqbn arduino:samd:mkr1000 MyFirstSketchSketch uses 9600 bytes (3%) of program storage space. Maximum is 262144 bytes.

$arduino-cli upload -p /dev/ttyACM0 --fqbn arduino:samd:mkr1000 MyFirstSketchNo new serial port detected.Atmel SMART device 0x10010005 foundDevice       : ATSAMD21G18AChip ID      : 10010005Version      : v2.0 [Arduino:XYZ] Dec 20 2016 15:36:43Address      : 8192Pages        : 3968Page Size    : 64 bytesTotal Size   : 248KBPlanes       : 1Lock Regions : 16Locked       : noneSecurity     : falseBoot Flash   : trueBOD          : trueBOR          : trueArduino      : FAST_CHIP_ERASEArduino      : FAST_MULTI_PAGE_WRITEArduino      : CAN_CHECKSUM_MEMORY_BUFFERErase flashdone in 0.784 secondsWrite 9856 bytes to flash (154 pages)[==============================] 100% (154/154 pages)done in 0.069 secondsVerify 9856 bytes of flash with checksum.Verify successfuldone in 0.009 secondsCPU reset.

Add libraries

$arduino-cli lib search debouncer  Name: "Debouncer"    Author: hideakitai    Maintainer: hideakitai    Sentence: Debounce library for Arduino    Paragraph: Debounce library for Arduino    Website: https://github.com/hideakitai    Category: Timing    Architecture: *    Types: Contributed    Versions: [0.1.0]  Name: "FTDebouncer"    Author: Ubi de Feo    Maintainer: Ubi de Feo, Sebastian Hunkeler    Sentence: An efficient, low footprint, fast pin debouncing library for Arduino    Paragraph: This pin state supervisor manages debouncing of buttons and handles transitions between LOW and HIGH state, calling a function and notifying your code of which pin has been activated or deactivated.    Website: https://github.com/ubidefeo/FTDebouncer    Category: Uncategorized    Architecture: *    Types: Contributed    Versions: [1.3.0]  Name: "SoftTimer"    Author: Balazs Kelemen <prampec+arduino@gmail.com>    Maintainer: Balazs Kelemen <prampec+arduino@gmail.com>    Sentence: SoftTimer is a lightweight pseudo multitasking solution for Arduino.    Paragraph: SoftTimer enables higher level Arduino programing, yet easy to use, and lightweight. You are often faced with the problem that you need to do multiple tasks at the same time. In SoftTimer, the programmer creates Tasks that runs periodically. This library comes with a collection of handy tools like blinker, pwm, debouncer.    Website: https://github.com/prampec/arduino-softtimer    Category: Timing    Architecture: *    Types: Contributed    Versions: [3.0.0, 3.1.0, 3.1.1, 3.1.2, 3.1.3, 3.1.5, 3.2.0]

$arduino-cli lib install FTDebouncer  FTDebouncer depends on FTDebouncer@1.3.0  Downloading FTDebouncer@1.3.0...  FTDebouncer@1.3.0 downloaded  Installing FTDebouncer@1.3.0...  Installed FTDebouncer@1.3.0

Getting help

$arduino-clihelp core  Arduino Core operations.  Usage:    arduino-cli core [command]  Examples:    ./arduino-cli core update-index  Available Commands:    download     Downloads one or more cores and corresponding tool dependencies.    install      Installs one or more cores and corresponding tool dependencies.    list         Shows the list of installed platforms.    search       Search for a core in the package index.    uninstall    Uninstalls one or more cores and corresponding tool dependencies if no more used.    update-index Updates the index of cores.    upgrade      Upgrades one or all installed platforms to the latest version.  Flags:    -h, --help   help for core  Global Flags:        --additional-urls strings   Additional URLs for the board manager.        --config-file string        The custom config file (if not specified the default will be used).        --format string             The output format, can be [text|json]. (default "text")        --log-file string           Path to the file where logs will be written.        --log-format string         The output format for the logs, can be [text|json].        --log-level string          Messages with this level and above will be logged.    -v, --verbose                   Print the logs on the standard output.  Use "arduino-cli core [command] --help" for more information about a command.

Troubleshooting

Using the gRPC interface