arduino-check automatically checks for common problems in your Arduino projects:
- Sketches
- Libraries
- Boards platforms
- Boards Manager package index
arduino-check [options...] [paths...]
paths Paths containing Arduino projects to check. If a path is a folder, it will be searched recursively
(configurable). If no path argument is provided, the current path is used. Subprojects (e.g., example sketches
of a library) will also be checked.
--project-type Only check the specified project types and their subprojects.
Can be {sketch|library|platform|package-index|all}. (default "all")
--permissive Only fail when critical issues are detected.
--recursive Search path recursively for Arduino projects to check. Can be {true|false}.
(default true)
--library-manager submit Also run the additional checks that are required to pass before a library is accepted
for inclusion in the Library Manager index.
--library-manager update Also run the additional checks that are required to pass before new releases of a
library already in Library Manager are accepted
--library-manager false Don't run any Library Manager-specific checks.
-h, --help help for arduino-check
--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. Valid levels are:
trace, debug, info, warn, error, fatal, panic
--format string The output format, can be {text|json}. (default "text")
--report-file string Save a report on the checks to this file.
-v, --verbose Print the logs on the standard output.
Set the ARDUINO_CHECK_OFFICIAL environment variable to "true" to run the checks that only apply to official Arduino projects.
We provide a GitHub Actions action that makes it easy to use arduino-check in your CI workflows!
Please visit https://github.com/arduino/arduino-check-action for more information.