pio-check 命令

常用示例

说明

pio check runs a static code analyzer over the sources of a PlatformIO project and reports defects grouped by severity (low, medium, high). Without `--tool` it uses the tool(s) configured in `platformio.ini`'s `check_tool` option; without `--environment` it iterates over every environment in the project. The check integrates the project's build flags, include paths, and target platform definitions so the analyzer sees the same macros and headers the compiler does — important for embedded code where `#ifdef` branches differ per MCU.

参数

-e, --environment _NAME_

Run the check only for the named build environment (as defined in `platformio.ini`).

-d, --project-dir _PATH_

Project directory. Defaults to the current directory.

-c, --project-conf _FILE_

Alternate `platformio.ini` path.

--tool _NAME_

Analysis tool: `cppcheck`, `clangtidy`, `pvs-studio`. May be repeated for multiple tools.

--severity _LEVEL_

Minimum defect severity to report: `low`, `medium`, `high`.

--fail-on-defect _LEVEL_

Return a non-zero exit code if defects of _LEVEL_ or higher are reported.

--pattern _PATTERN_

Glob patterns of files to analyze (alternative to `--src-filters`).

--src-filters _FILTER_

Include/exclude filter (e.g. `+<src/app/>`, `-<src/vendor/>`). Repeatable.

--flags _FLAGS_

Extra flags passed to the tool. Prefix with `<tool>:` to target one tool (e.g. `cppcheck: --std=c++17`).

--skip-packages

Skip third-party frameworks and toolchain sources.

--json-output

Emit results as JSON instead of human-readable text.

-s, --silent

Suppress output except errors.

-v, --verbose

Verbose output.