Aller au contenu
vetkit

Documentation

Développer avec vetkit

Tout ce que vous pouvez faire dans l’application vetkit est accessible par programmation. Commencez par une clé d’API, puis choisissez l’interface adaptée à votre façon de travailler.

Démarrage rapide

  1. Demandez un accès anticipé. Une fois votre accès activé, connectez-vous avec GitHub et installez la GitHub App vetkit sur les dépôts que vous souhaitez auditer.
  2. Dans l’application, ouvrez Paramètres → Clés d’API et créez une clé avec les portées dont vous avez besoin. Le secret n’est affiché qu’une seule fois — conservez-le dans votre gestionnaire de mots de passe ou de secrets.
  3. Suivez le guide MCP pour utiliser vetkit depuis votre agent de code, ou le guide de l’API pour l’appeler depuis vos scripts et votre CI.

Concepts

  • Organisation — possède les dépôts, les audits et les clés d’API. Chacun dispose d’une organisation personnelle ; les organisations d’équipe ajoutent des membres avec des rôles.
  • Dépôt — un dépôt GitHub connecté via la GitHub App vetkit.
  • Audit — une exécution de tous les analyseurs sur un commit précis. Le statut passe de QUEUED à RUNNING, puis à SUCCEEDED, FAILED ou CANCELLED.
  • Constat — un problème unique, avec catégorie, gravité, règle, fichier et ligne. Chaque constat possède une empreinte : lors d’un nouvel audit, il est marqué comme nouveau ou existant.
  • Rapport — la synthèse notée d’un audit, disponible en JSON, Markdown ou SARIF 2.1.0.