ARDUINO-CLI-COMPILE(1)

📦
version 1.5.1 · 2 versions
, in ubuntu stonking

💖 ARDUINO-CLI-COMPILE(1) 💖

okay bestie, welcome to the Arduino Command Line Manual — yes, that's the whole manual name, she's fancy like that. we're talking about arduino-cli-compile today and honestly? she's the main character of your whole build process. let's get into it 🫶

✨ NAME ✨

arduino-cli-compile — Compiles Arduino sketches.

like. that's it. that's her job. she compiles Arduino sketches. no cap.

🌸 SYNOPSIS 🌸

arduino-cli compile [flags]

🦋 DESCRIPTION 🦋

Compiles Arduino sketches.

(it's giving "short and confident". iconic behavior honestly. don't overthink it, just know that when you type compile, your sketch is getting turned into something your board can actually run 💅)

🎀 OPTIONS 🎀

okay this is the big one. buckle up, there's a LOT, but every single one of them is useful so let's go:

  • --board-options=[] — a list of board options separated by commas. or you can hit her with it multiple times for multiple options, whatever vibes ✨
  • --build-path="" — where to save the compiled files. if you leave it empty, a directory gets created in the default temporary path of your OS. lowkey convenient 🍓
  • --build-property=[] — override a build property with a custom value. can be used multiple times for multiple properties.
  • --clean[=false] — optional; cleanup the build folder and do not use any cached build. full fresh start energy 🧚
  • --discovery-timeout=1s — max time to wait for port discovery. e.g.: 30s, 1m
  • --dump-profile[=false] — create and print a profile configuration from the build.
  • --encrypt-key="" — the name of the custom encryption key to use to encrypt a binary during the compile process. used only by the platforms that support it 🫡
  • -e, --export-binaries[=false] — if set, built binaries will be exported to the sketch folder.
  • -b, --fqbn="" — Fully Qualified Board Name, e.g.: arduino:avr:uno
  • -h, --help[=false] — help for compile
  • -j, --jobs=0 — max number of parallel compiles. if set to 0, the number of available CPUs cores will be used. let her cook 🔥
  • --keys-keychain="" — the path of the dir to search for the custom keys to sign and encrypt a binary. used only by the platforms that support it.
  • --libraries=[] — path to a collection of libraries. can be used multiple times, or entries can be comma separated.
  • --library=[] — path to a single library's root folder. can be used multiple times, or entries can be comma separated.
  • --only-compilation-database[=false] — just produce the compilation database, without actually compiling. all build commands are skipped except pre* hooks. iykyk
  • --optimize-for-debug[=false] — optional; optimize compile output for debugging rather than for release.
  • --output-dir="" — save build artifacts in this directory.
  • -p, --port="" — upload port address, e.g.: COM3 or /dev/ttyACM2
  • --preprocess[=false] — print preprocessed code to stdout instead of compiling. 💀 just looking, not touching
  • -m, --profile="" — sketch profile to use
  • -P, --programmer="" — programmer to use, e.g: atmel_ice
  • -l, --protocol="" — upload port protocol, e.g: serial
  • -q, --quiet[=false] — optional; suppresses almost every output. (almost!! not all!! 🙈)
  • --show-properties[="disabled"] — show build properties. the properties are expanded, so use "--show-properties=unexpanded" if you want them exactly as they are defined. picky queen behavior and we respect it 👑
  • --sign-key="" — the name of the custom signing key to use to sign a binary during the compile process. used only by the platforms that support it.
  • -u, --upload[=false] — upload the binary after the compilation.
  • -v, --verbose[=false] — optional; turns on verbose mode. she will tell you EVERYTHING 🌈
  • -t, --verify[=false] — verify uploaded binary after the upload.
  • --warnings="none" — optional; can be: none, default, more, all. used to tell gcc which warning level to use (-W flag).

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these ones come from the parent command arduino-cli — she shares her toys, so cute:

  • --additional-urls=[] — comma-separated list of additional URLs for the Boards Manager.
  • --config-dir="" — sets the default data directory (Arduino CLI will look for configuration file in this directory).
  • --config-file="" — the custom config file (if not specified the default will be used).
  • --json[=false] — print the output in JSON format.
  • --log[=false] — print the logs on the standard output.
  • --log-file="" — path to the file where logs will be written.
  • --log-format="text" — the output format for the logs, can be: text, json
  • --log-level="info" — messages with this level and above will be logged. valid levels are: trace, debug, info, warn, error, fatal, panic
  • --no-color[=false] — disable colored output. 😭 (why would you. but okay. valid.)

⭐ EXAMPLE ⭐

here's how the girlies actually run her, verbatim, no edits:

debian/build/bin/arduino-cli compile -b arduino:avr:uno /home/user/Arduino/MySketch
debian/build/bin/arduino-cli compile -b arduino:avr:uno --build-property "build.extra_flags=\"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch
debian/build/bin/arduino-cli compile -b arduino:avr:uno --build-property "build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch
debian/build/bin/arduino-cli compile -b arduino:avr:uno --build-property build.extra_flags=-DPIN=2 --build-property "compiler.cpp.extra_flags=\"-DSSID=\"hello world\"\"" /home/user/Arduino/MySketch

like yes, those quotes are doing gymnastics. yes, they're correct. that's just how it eats 💅

🔍 SEE ALSO 🔍

go read her too, she's the parent, she's got the lore 🌸

📜 HISTORY 📜

15-Aug-2026 — Auto generated by spf13/cobra

and that's the whole page bestie!! 🎀 this manual page belongs to the Arduino Command Line Manual, auto generated by spf13/cobra, dated Aug 2026 — so if you ever forget where all this came from, it's cobra's baby, and it's adorable. now go compile something iconic 💖✨👑

📦 where this page comes from