pdfv

English | 简体中文

pdfv is a Rust PDF conformance validator with a library-first core and a CLI for local files, repositories, and CI jobs.

The current product validates PDF/A-oriented and imported veraPDF profiles with a bounded parser and rule engine, emits deterministic reports, extracts bounded feature/policy data, and keeps hostile input behind explicit resource limits.

Install from the workspace:

cargo install --path apps/cli

Validate one file:

pdfv validate tests/fixtures/minimal-valid.pdf --format text

Write a machine-readable report:

pdfv validate ./documents --recursive --jobs 4 --format json --output report.json

List built-in profiles:

pdfv profiles list

Repair metadata to a separate output directory:

pdfv repair-metadata input.pdf --output-dir repaired --prefix fixed- --format json

• User Guide
• Developer Guide
• JSON and Config Examples
• veraPDF CLI Compatibility
• Documentation Index

Chinese documentation:

• 用户指南
• 开发者指南

pdfv validate supports:

• Report formats: json, json-pretty, text, xml, mrr, raw, html.
• Profile selection: --flavour, --default-flavour, --profile.
• Batch discovery: --recursive, --non-pdf-extension, --jobs.
• Reporting controls: --output, --redact-paths, --record-passes, --max-failures.
• Password sources: --password-stdin, --password-file, --password-env.
• Feature and policy reports: --extract, --policy-file.

Exit codes are stable for automation:

Runtime defaults can live in YAML:

validation:
  flavour: auto
  defaultFlavour: pdfa-1b
  recordPassedAssertions: false
resources:
  maxFileBytes: 268435456
  maxObjects: 1000000
  maxObjectDepth: 128
  maxArrayLen: 65536
  maxDictEntries: 16384
  maxNameBytes: 127
  maxStringBytes: 1048576
  maxStreamDeclaredBytes: 134217728
  maxStreamDecodeBytes: 268435456
  maxParseFacts: 100000
output:
  format: json
  path: report.json
  redactPaths: true

Use it with:

pdfv validate --config pdfv.yaml ./documents --recursive

use pdfv_core::{ReportFormat, Validator};

let validator = Validator::default();
let report = validator.validate_path("tests/fixtures/minimal-valid.pdf")?;
ReportFormat::JsonPretty.write_report(&report, std::io::stdout())?;
# Ok::<(), pdfv_core::PdfvError>(())

Required local gates:

cargo build --workspace --all-targets
cargo test --workspace --all-targets
cargo +nightly fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
cargo clippy --workspace --all-targets -- -D warnings -W clippy::pedantic -W clippy::unwrap_used -W clippy::expect_used -W clippy::indexing_slicing -W clippy::panic
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps
cargo audit
cargo deny check

See the Developer Guide for workflow details.

This project is distributed under the terms of the Mozilla Public License 2.0.

See THIRD_PARTY_LICENSES.md for vendored veraPDF license notices.

See LICENSE for details.