WeaveDocs
Schema Check

Commands

Every `schema-check` command, flag, and exit code — useful for CI gating and pre-commit validation.

Purpose

Schema validation utility for protocol and documentation contracts.

This page follows the real source shape for Schema Check and explains the workflow a developer is likely to use first.

Command surface

Use this page to understand the operational commands exposed by the tool. Prefer command groups that match the subsystem you are testing, then inspect the API surface page for the exact Rust enum or command handler.

Primary types to know

  • No public items were detected by the source scan. This page should be updated when the crate exposes new items.

Example shape

# Command surface — every schema-check subcommand and its primary flags.

schema-check list-schemas
schema-check show <schema-id>          # print the canonical schema
schema-check validate <file> --schema <schema-id>
schema-check validate-dir <dir>   --schema <schema-id> [--recursive]
schema-check diff <a.json> <b.json> --schema <schema-id>
schema-check hash <file>               # print canonical content hash
schema-check fmt <file> --in-place     # rewrite to canonical form
schema-check pack <dir> --out artifacts.tar.zst