V OpenVet / docs
docs

OpenVet Documentation

User-facing documentation for OpenVet — concepts, tutorials, guides, and reference.

OpenVet is an open standard for cryptographically signed software dependency audits, plus the tooling to publish, distribute, and consume them. These docs are organised around what you’re trying to do.

  • Concepts — what OpenVet is, how it works, and how it compares to adjacent tools. Read these to evaluate or to build a mental model.
  • Getting started — install the CLI and get a passing openvet check in a few minutes.
  • Tutorials — guided walk-throughs that take you end-to-end through a complete workflow.
  • Guides — task-oriented recipes for specific problems (“how do I rotate a key”).
  • CLI reference — every openvet subcommand, with flags and worked examples.
  • Reference — configuration schemas, requirement syntax, and the protocol specification.

If you’ve never touched OpenVet, start with What is OpenVet and then run through Quickstart.

Concepts Background on what OpenVet is, how it works, and how it relates to existing tools. Getting started Install the CLI and run OpenVet against your project for the first time. Tutorials Walk-throughs that take you end-to-end through a real OpenVet workflow. Guides Task-oriented recipes for specific OpenVet problems. Reference Configuration schemas, requirement syntax, and the protocol specification. CLI reference Every openvet subcommand, with flags and worked examples.