Dokümantasyon
vetkit ile geliştirin
vetkit uygulamasında yapabildiğiniz her şeyi programatik olarak da yapabilirsiniz. Bir API anahtarıyla başlayın, ardından iş akışınıza uyan arayüzü seçin.
- MCP sunucusuClaude Code’a ya da herhangi bir MCP istemcisine depo bağlama, denetim çalıştırma ve bulguları okuma araçları kazandırın.
- REST APIBir API anahtarıyla kimlik doğrulayın, denetimleri CI üzerinden başlatın, sonuçları düzenli aralıklarla sorgulayın ve SARIF indirin.
Hızlı başlangıç
- Erken erişim talep edin. Erişiminiz açıldıktan sonra GitHub ile giriş yapın ve vetkit GitHub App’i denetlemek istediğiniz depolara kurun.
- Uygulamada Ayarlar → API anahtarları sayfasını açın ve ihtiyacınız olan kapsamlarla bir anahtar oluşturun. Anahtarın gizli değeri yalnızca bir kez gösterilir — parola yöneticinizde veya gizli bilgi kasanızda saklayın.
- vetkit’i kodlama ajanınızdan kullanmak için MCP kılavuzunu, betiklerden ve CI üzerinden çağırmak için API kılavuzunu izleyin.
Kavramlar
- Kuruluş — depoların, denetimlerin ve API anahtarlarının sahibidir. Herkesin kişisel bir kuruluşu vardır; ekip kuruluşlarına rollerle üye eklenir.
- Depo — vetkit GitHub App aracılığıyla bağlanan bir GitHub deposu.
- Denetim — tüm analizörlerin belirli bir commit üzerinde bir kez çalıştırılması. Durum
QUEUEDdeğerindenRUNNINGdeğerine, oradan daSUCCEEDED,FAILEDveyaCANCELLEDdeğerine geçer. - Bulgu — kategori, önem derecesi, kural, dosya ve satır bilgisi içeren tek bir sorun. Bulgulara parmak izi atanır; böylece yeniden yapılan denetimler onları yeni ya da mevcut olarak işaretler.
- Rapor — bir denetimin notlandırılmış özeti; JSON, Markdown veya SARIF 2.1.0 olarak alınabilir.