All apps/Arduino CLI

Arduino CLI

arduino-cli

An all-in-one solution that provides Boards/Library Managers, sketch builder, board detection and uploader.

Runs as arduino-cli|macOS, Linux, Windows|arduino.github.io

Command form

ai-draft · 6 tasks · 26 fields

Compile and upload sketches and manage boards, cores and libraries. Daemon, debug and config commands are left out.

Opens the form; the finished command lands at your prompt, unrun
otty gui arduino-cli
Arduino CLIExample values, fixed in this page — nothing here reaches a terminal
Basic
Output format
string
Advanced
No color
--no-color
Config file
file
ParametersOnly these flags are editable in the form
Output format
string
--formattextjsonjsonminiyaml
No color
boolean
--no-color
Config file
path
--config-file

arduino-cli compile

Compile a sketch

Compile a sketch for a board.

Compile a sketchExample values, fixed in this page — nothing here reaches a terminal
Basic
Sketch folder
directory
Board (FQBN)*
string
Advanced
Verbose
--verbose
Warning level
string
TasksEach one presets the form for one job
Compile
sketchfqbnwarningsverbose
Compile and upload
sketchfqbnportuploadverify
ParametersOnly these flags are editable in the form
Sketch folder
path · positional 0
Board (FQBN)
Example: arduino:avr:uno.
string
--fqbn-b
Upload after compiling
boolean
--upload-u
Port
Example: /dev/ttyACM0 or COM3.
string
--port-p
Verify after upload
boolean
--verify-t
Clean build, no cache
boolean
--clean
Verbose
boolean
--verbose-v
Warning level
string
--warningsnonedefaultmoreall
Build path
path
--build-path
Output directory
path
--output-dir
Library folders
path · repeatable
--library
Optimize for debugging
boolean
--optimize-for-debug

arduino-cli upload

Upload a sketch

Upload a compiled sketch. This does not compile first.

Upload a sketchExample values, fixed in this page — nothing here reaches a terminal
Basic
Sketch folder
directory
Board (FQBN)*
string
Port*
string
Verify after upload
--verify
TasksEach one presets the form for one job
Upload
sketchfqbnportverify
ParametersOnly these flags are editable in the form
Sketch folder
path · positional 0
Board (FQBN)
Example: arduino:avr:uno.
string
--fqbn-b
Port
Example: /dev/ttyACM0 or COM3.
string
--port-p
Verify after upload
boolean
--verify-t
Binary file
path
--input-file-i
Verbose
boolean
--verbose-v

arduino-cli board list

List connected boards

Detect boards connected to this computer.

List connected boardsExample values, fixed in this page — nothing here reaches a terminal
TasksEach one presets the form for one job
List boards
ParametersOnly these flags are editable in the form
Keep running and print changes
boolean
--watch-w

arduino-cli core install

Install a core

Install board platforms, for example arduino:avr.

Install a coreExample values, fixed in this page — nothing here reaches a terminal
Basic
Cores*
string
TasksEach one presets the form for one job
Install cores
cores
ParametersOnly these flags are editable in the form
Cores
string · positional 0 · repeatable
Do not overwrite installed
boolean
--no-overwrite

arduino-cli lib install

Install a library

Install libraries by name, from a Git URL or from a zip file.

Install a libraryExample values, fixed in this page — nothing here reaches a terminal
Basic
Libraries*
string
Skip dependencies
--no-deps
TasksEach one presets the form for one job
Install libraries
libsno_deps
ParametersOnly these flags are editable in the form
Libraries
Name, optionally with @version.
string · positional 0 · repeatable
Skip dependencies
boolean
--no-deps
SourcesEvery flag above is checked against these
fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

Before it fills your prompt, Otty checks the installed arduino-cli against its version. A form that does not match your version is not offered.