# vet documentation

## User guide

- [install.md](install.md): the install channels of vet v2, and how to verify a release.
- [cmd/README.md](cmd/README.md): every command, with its flags, examples and exit codes.
- [controls.md](controls.md): the controls, their families, severities and options.
- [policy.md](policy.md): how to write a policy, test it and use it as a gate.
- [output.md](output.md): the report formats, the saved scans and the configuration.
- [github-action.md](github-action.md): the vet GitHub Action, its inputs, the comment and the gate.
- [ci.md](ci.md): GitHub Actions, GitLab CI, Bitbucket Pipelines and AI agents.
- [inventory.md](inventory.md): code usage, the AI and crypto inventory, the xBOM and the CBOM.
- [release-notes/](release-notes): the changes that each release asks of a user.

## Contributors

- [glossary.md](glossary.md): the terms of vet v2, and the code that owns each concept.
- [DEVGUIDE.md](DEVGUIDE.md): how to add or change a command, and the conventions that the tests
  check.
- [../test/acceptance/README.md](../test/acceptance/README.md): the acceptance suite, and how to
  add a guarantee.
- [../test/evasion/README.md](../test/evasion/README.md): the evasion corpus of the attack
  detections, and how to add a case.
- [../test/falsepositive/README.md](../test/falsepositive/README.md): the false-positive run on
  clean projects.