Перейти к содержимому
vetkit

Документация

Разработка с vetkit

Всё, что можно сделать в приложении vetkit, доступно и программно. Начните с API-ключа, а затем выберите интерфейс, который подходит вашему рабочему процессу.

Быстрый старт

  1. Запросите ранний доступ. Получив доступ, войдите через GitHub и установите GitHub App vetkit для репозиториев, которые хотите проверять.
  2. В приложении откройте Настройки → API-ключи и создайте ключ с нужными областями доступа. Секрет показывается один раз — сохраните его в менеджере паролей или хранилище секретов.
  3. Следуйте руководству по MCP, чтобы использовать vetkit из вашего ИИ-агента, или руководству по API, чтобы вызывать его из скриптов и CI.

Основные понятия

  • Организация — владеет репозиториями, аудитами и API-ключами. У каждого пользователя есть личная организация; в командные организации можно добавлять участников с ролями.
  • Репозиторий — репозиторий GitHub, подключённый через GitHub App vetkit.
  • Аудит — один запуск всех анализаторов для конкретного коммита. Статус меняется с QUEUED на RUNNING, а затем на SUCCEEDED, FAILED или CANCELLED.
  • Находка — отдельная проблема с категорией, критичностью, правилом, файлом и строкой. У находок есть отпечатки, поэтому при повторных аудитах они помечаются как новые или существующие.
  • Отчёт — итоговая сводка аудита с оценкой в формате JSON, Markdown или SARIF 2.1.0.