Valkyrian Labs logo

Local Validation

Validate, manifest, and plan docs changes before pushing.

Local Validation

Local validation is the fastest feedback loop for docs authors and agents.

  1. 1

    Validate

    Run pmdocs validate --source main-docs.

  2. 2

    Inspect a manifest

    Run pmdocs manifest --source main-docs --pretty.

  3. 3

    Preview a plan

    Run pmdocs plan --source main-docs.

Validate

1pmdocs validate --source main-docs2pmdocs validate ./docs --source main-docs

Validation checks source paths, frontmatter, asset paths, hashes, file limits, docs set slug, and manifest shape. It also lists every file the docs walk leaves out (symlinks, README.MD-style extensions, node_modules, and root-level build / dist / .next directories) and every hidden file it includes, so nothing is dropped silently. Pass --skip-hidden to exclude hidden files and directories.

Manifest

1pmdocs manifest --source main-docs --pretty2pmdocs manifest ./docs --source main-docs --pretty

The manifest is JSON. Human docs are emitted as files; skills and optional custom static fallback files are emitted as assets. Skills are optional: a missing default ./skills directory is skipped, while an explicitly supplied missing --skills <path> is treated as a configuration error. The manifest includes content and SHA-256 hashes, but it does not include server-owned target collection or field names.

Plan

1pmdocs plan --source main-docs2pmdocs plan ./docs --source main-docs

Without --existing, local planning assumes an empty target and reports creates. Pass --publish when the push will publish, --existing-assets to compare assets, and --route-base when the docs set lives in a group or uses product-nested routes. Server-side dry-runs (pmdocs push --dry-run) plan against current Payload records.

The native pmdocs binary is the supported CLI for docs validation, planning, key generation, and publishing. The npm package installs the Payload plugin and runtime helpers only.

See CLI reference.