Arduino cli compile








































compile

arduino-cli compile

Compiles Arduino sketches.

Synopsis

Compiles Arduino sketches.

1arduino-cli compile [flags]

Examples

1arduino-cli compile -b arduino:avr:uno /home/user/Arduino/MySketch
2 arduino-cli compile -b arduino:avr:uno --build-property "build.extra_flags=\"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch
3 arduino-cli compile -b arduino:avr:uno --build-property "build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch
4 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

Options

1--board-options strings List of board options separated by commas. Or can be used multiple times for multiple options.
2 --build-path string Path where to save compiled files. If omitted, a directory will be created in the default temporary path of your OS.
3 --build-property stringArray Override a build property with a custom value. Can be used multiple times for multiple properties.
4 --clean Optional, cleanup the build folder and do not use any cached build.
5 --discovery-timeout duration Max time to wait for port discovery, e.g.: 30s, 1m (default 1s)
6 --dump-profile Create and print a profile configuration from the build.
7 --encrypt-key string 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.
8 -e, --export-binaries If set built binaries will be exported to the sketch folder.
9 -b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno
10 -h, --help help for compile
11 -j, --jobs int32 Max number of parallel compiles. If set to 0 the number of available CPUs cores will be used.
12 --keys-keychain string 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.
13 --libraries strings Path to a collection of libraries. Can be used multiple times or entries can be comma separated.
14 --library strings Path to a single library’s root folder. Can be used multiple times or entries can be comma separated.
15 --only-compilation-database Just produce the compilation database, without actually compiling. All build commands are skipped except pre* hooks.
16 --optimize-for-debug Optional, optimize compile output for debugging, rather than for release.
17 --output-dir string Save build artifacts in this directory.
18 -p, --port string Upload port address, e.g.: COM3 or /dev/ttyACM2
19 --preprocess Print preprocessed code to stdout instead of compiling.
20 -m, --profile string Sketch profile to use
21 -P, --programmer string Programmer to use, e.g: atmel_ice
22 -l, --protocol string Upload port protocol, e.g: serial
23 -q, --quiet Optional, suppresses almost every output.
24 --show-properties string[="expanded"] Show build properties. The properties are expanded, use "--show-properties=unexpanded" if you want them exactly as they are defined. (default "disabled")
25 --sign-key string 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.
26 -u, --upload Upload the binary after the compilation.
27 -v, --verbose Optional, turns on verbose mode.
28 -t, --verify Verify uploaded binary after the upload.
29 --warnings string Optional, can be: none, default, more, all. Used to tell gcc which warning level to use (-W flag). (default "none")

Options inherited from parent commands

1--additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
2 --config-dir string Sets the default data directory (Arduino CLI will look for configuration file in this directory).
3 --config-file string The custom config file (if not specified the default will be used).
4 --json Print the output in JSON format.
5 --log Print the logs on the standard output.
6 --log-file string Path to the file where logs will be written.
7 --log-format string The output format for the logs, can be: text, json (default "text")
8 --log-level string Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
9 --no-color Disable colored output.

SEE ALSO

In this page you can check the latest version of the Arduino CLI. You can find previous versions here.