Saltar al contenido
vetkit

Documentación

Desarrolla con vetkit

Todo lo que puedes hacer en la app de vetkit también está disponible de forma programática. Empieza con una clave de API y luego elige la interfaz que mejor se adapte a tu flujo de trabajo.

Inicio rápido

  1. Solicita acceso anticipado. Una vez que tengas acceso, inicia sesión con GitHub e instala la GitHub App de vetkit en los repositorios que quieras auditar.
  2. En la app, abre Configuración → Claves de API y crea una clave con los ámbitos que necesites. El secreto se muestra una sola vez: guárdalo en tu gestor de contraseñas o en tu almacén de secretos.
  3. Sigue la guía de MCP para usar vetkit desde tu agente de programación, o la guía de la API para llamarlo desde scripts y CI.

Conceptos

  • Organización — es la propietaria de los repositorios, las auditorías y las claves de API. Cada persona tiene una organización personal; las organizaciones de equipo añaden miembros con roles.
  • Repositorio — un repositorio de GitHub conectado a través de la GitHub App de vetkit.
  • Auditoría — una ejecución de todos los analizadores sobre un commit concreto. El estado pasa de QUEUED a RUNNING y después a SUCCEEDED, FAILED o CANCELLED.
  • Hallazgo — un problema concreto con categoría, severidad, regla, archivo y línea. Cada hallazgo tiene una huella, así que las nuevas auditorías lo marcan como nuevo o existente.
  • Informe — el resumen con calificación de una auditoría, disponible en JSON, Markdown o SARIF 2.1.0.