privateer / docs
Home Docs
Docs

Tutorials

  • Your first validation run

How-to guides

  • Installation
  • Upgrading Privateer
  • Controlling output
  • GitHub Actions integration
  • Troubleshooting
  • Build your first plugin

Reference

  • CLI reference
  • Configuration reference
  • Output schema
  • Plugin catalog
  • Glossary

Explanation

  • Privateer in pictures
  • Introduction to Privateer

Tutorials

  • Your first validation run

How-to guides

  • Installation
  • Upgrading Privateer
  • Controlling output
  • GitHub Actions integration
  • Troubleshooting
  • Build your first plugin

Reference

  • CLI reference
  • Configuration reference
  • Output schema
  • Plugin catalog
  • Glossary

Explanation

  • Privateer in pictures
  • Introduction to Privateer

Reference

CLI reference

Every pvtr subcommand, its flags, and usage examples.

Configuration reference

Every config key, variable resolution rules, and the policy block.

Output schema

File locations, the results file structure, result values, and SARIF.

Plugin catalog

Where to find community plugins for OSPS Baseline, FINOS CCC, and more.

Glossary

Plain-language definitions of the terms used across the Privateer docs.