Plesty Documentation

Your First Check

Run plesty check and understand the output for each compliance standard.

Running the check

From inside any PLESTY module directory:

uv run plesty check

The default standard is quantum (all local gates). Add --standard to run a subset:

uv run plesty check --standard pixel    # metadata + code hygiene only (~5 s)
uv run plesty check --standard nebula   # all local static analysis (~15 s)
uv run plesty check --standard quantum  # full verification (~60–120 s)

Example output — all gates passing

plesty check — quantum standard

[SDK]  Gate 1  Metadata & Namespace          PASS
[SDK]  Gate 2  Code Hygiene                  PASS
[SDK]  Gate 3  API Interface Matching         PASS
[SDK]  Gate 4  Data Layer Compliance          PASS
[SDK]  Gate 5  Documentation Completeness     PASS
[SDK]  Gate 6  Dependency Coexistence         PASS
[SDK+CI] Gate 7  Automated Test Coverage      PASS  (coverage: 87%)
[SDK+CI] Gate 8  Semantic Versioning          PASS  (no unreleased commits since v0.2.1)
[SDK+CI] Gate 9  Licensing Compliance         PASS
[SDK+CI] Gate 10 Vulnerability Audit          PASS  (0 CVEs found)
[SDK]  Gate 11 Docs Build                     PASS
[Device] Gate d1 Device API Pipeline          PASS  (8/8 mock gates)

All 12 gates passed.

Standards comparison

Standard Gates run Typical use
pixel 1–2 Quick sanity check; safe to run before every commit
nebula 1–6 Pre-push default; catches all static issues without network
quantum 1–11 + d1 Required before tagging a release

First run on a fresh scaffold

A freshly scaffolded project (plesty init device) passes all gates immediately — the scaffold is pre-configured to be plesty check-clean from the first commit.

If you are working on a legacy module or one migrated from the deprecated group, expect failures in Gate 2 (code hygiene) and Gate 5 (documentation) on the first run. See Fixing Failures.