V OpenVet / docs
docs

OpenVet Documentation

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

WARNING

OpenVet is still under active development. The public registry at openvet.org is a pre-release deployment intended for testing, and should not be used for production data. Expect resets and breaking changes as we refine the data structures and protocol.

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.
  • Landscape — how OpenVet relates to other supply-chain auditing and dependency-security tools, organised by the role each plays.
  • 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. Landscape How OpenVet relates to existing supply-chain auditing and dependency-security tools in the broader landscape. 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.