Skip to content
vetkit

Documentation

Build with vetkit

Everything you can do in the vetkit app is available programmatically. Start with an API key, then pick the interface that fits your workflow.

Quickstart

  1. Request early access. Once you are in, sign in with GitHub and install the vetkit GitHub App on the repositories you want to audit.
  2. In the app, open Settings → API keys and create a key with the scopes you need. The secret is shown once — store it in your password manager or secret store.
  3. Follow the MCP guide to use vetkit from your coding agent, or the API guide to call it from scripts and CI.

Concepts

  • Organization — owns repositories, audits and API keys. Everyone gets a personal organization; team organizations add members with roles.
  • Repository — a GitHub repository connected through the vetkit GitHub App.
  • Audit — one run of all analyzers against a specific commit. Status moves from QUEUED to RUNNING to SUCCEEDED, FAILED or CANCELLED.
  • Finding — a single issue with category, severity, rule, file and line. Findings are fingerprinted, so re-audits mark them as new or existing.
  • Report — the graded summary of an audit, available as JSON, Markdown or SARIF 2.1.0.