Pular para o conteúdo
vetkit

Documentação

Desenvolva com o vetkit

Tudo o que você faz no app vetkit também está disponível programaticamente. Comece com uma chave de API e escolha a interface que melhor se encaixa no seu fluxo de trabalho.

Início rápido

  1. Solicite acesso antecipado. Assim que tiver acesso, entre com o GitHub e instale o GitHub App do vetkit nos repositórios que você quer auditar.
  2. No app, abra Configurações → Chaves de API e crie uma chave com os escopos de que você precisa. O segredo é exibido uma única vez — guarde-o no seu gerenciador de senhas ou cofre de segredos.
  3. Siga o guia do MCP para usar o vetkit no seu agente de programação, ou o guia da API para chamá-lo a partir de scripts e do CI.

Conceitos

  • Organização — é dona de repositórios, auditorias e chaves de API. Todo mundo recebe uma organização pessoal; organizações de equipe adicionam membros com funções.
  • Repositório — um repositório do GitHub conectado por meio do GitHub App do vetkit.
  • Auditoria — uma execução de todos os analisadores em um commit específico. O status passa de QUEUED para RUNNING e depois para SUCCEEDED, FAILED ou CANCELLED.
  • Achado — um único problema com categoria, severidade, regra, arquivo e linha. Os achados recebem uma impressão digital, por isso novas auditorias os marcam como novos ou existentes.
  • Relatório — o resumo com nota de uma auditoria, disponível em JSON, Markdown ou SARIF 2.1.0.