From 5c9261d7fde140d8fd8f22873d184db2eb49a090 Mon Sep 17 00:00:00 2001 From: marchersimon <50295997+marchersimon@users.noreply.github.com> Date: Sun, 28 Mar 2021 20:26:38 +0200 Subject: [PATCH] pio-check: add page (#5519) --- pages/common/pio-check.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pages/common/pio-check.md diff --git a/pages/common/pio-check.md b/pages/common/pio-check.md new file mode 100644 index 0000000000..2f673b2369 --- /dev/null +++ b/pages/common/pio-check.md @@ -0,0 +1,24 @@ +# pio check + +> Perform a static analysis check on a PlatformIO project. +> More information: . + +- Perform a basic analysis check on the current project: + +`pio check` + +- Perform a basic analysis check on a specific project: + +`pio check --project-dir {{project_dir}}` + +- Perform an analysis check for a specific environment: + +`pio check --environment {{environment}}` + +- Perform an analysis check and only report a specified defect severity type: + +`pio check --severity {{low|medium|high}}` + +- Perform an analysis check and show detailed information when processing environments: + +`pio check --verbose`