Skip to content

Commit

Permalink
pio-check: add page (#5519)
Browse files Browse the repository at this point in the history
  • Loading branch information
marchersimon authored Mar 28, 2021
1 parent 2e1d5f5 commit 5c9261d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions pages/common/pio-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# pio check

> Perform a static analysis check on a PlatformIO project.
> More information: <https://docs.platformio.org/en/latest/core/userguide/cmd_check.html>.
- 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`

0 comments on commit 5c9261d

Please sign in to comment.