Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.claboard.dev/llms.txt

Use this file to discover all available pages before exploring further.

Projeleri Listele

GET /api/projects
Tüm projeleri temel bilgileriyle birlikte döndürür.
[
  {
    "id": 1,
    "name": "My App",
    "slug": "my-app",
    "workingDir": "/home/user/my-app",
    "createdAt": "2025-01-15T10:00:00Z"
  }
]

Proje Özetini Getir

GET /api/projects/summary
Tüm projeleri duruma göre görev sayılarıyla birlikte döndürür. Genel pano görünümü için kullanışlıdır.
[
  {
    "id": 1,
    "name": "My App",
    "slug": "my-app",
    "workingDir": "/home/user/my-app",
    "backlogCount": 5,
    "inProgressCount": 2,
    "testingCount": 1,
    "doneCount": 12
  }
]

Proje Getir

GET /api/projects/:id
İzin modu, izin verilen araçlar, kuyruk yapılandırması, git ayarları, otomatik test ve GitHub entegrasyonu dahil tam ayarlarıyla birlikte tek bir projeyi döndürür.
{
  "id": 1,
  "name": "My App",
  "slug": "my-app",
  "workingDir": "/home/user/my-app",
  "icon": null,
  "iconSeed": null,
  "permissionMode": "auto-accept",
  "allowedTools": null,
  "autoQueue": 1,
  "maxConcurrent": 2,
  "autoBranch": 1,
  "autoPr": 0,
  "prBaseBranch": "main",
  "autoTest": 0,
  "testPrompt": "",
  "taskTimeoutMinutes": null,
  "maxRetries": 0,
  "githubRepo": "owner/repo",
  "githubSyncEnabled": 0,
  "createdAt": "2025-01-15T10:00:00Z"
}

Proje Oluştur

POST /api/projects
Content-Type: application/json
{
  "name": "My App",
  "slug": "my-app",
  "workingDir": "/home/user/my-app",
  "permissionMode": "auto-accept",
  "allowedTools": [],
  "icon": null,
  "iconSeed": null
}
AlanZorunluAçıklama
nameEvetProje görünen adı
slugEvetURL uyumlu tanımlayıcı (benzersiz olmalı)
workingDirEvetKod tabanının mutlak yolu
permissionModeHayırauto-accept, allow-tools, default
allowedToolsHayırVirgülle ayrılmış araç adları (allow-tools modu için)
iconHayırÖzel simge tanımlayıcısı
iconSeedHayırOtomatik oluşturulan simge için tohum
Kuyruk, git, otomatik test ve GitHub entegrasyonu gibi ek ayarlar, oluşturma sonrasında Proje Güncelle ile yapılandırılır.

Proje Güncelle

PUT /api/projects/:id
Content-Type: application/json
Aşağıdaki alanların herhangi bir kombinasyonunu kabul eder. Yalnızca gönderilen alanlar güncellenir.
{
  "name": "My App (Güncellenmiş)",
  "autoQueue": true,
  "maxConcurrent": 3,
  "autoBranch": true,
  "autoPr": true,
  "prBaseBranch": "develop",
  "autoTest": true,
  "testPrompt": "Run npm test and verify all pass",
  "taskTimeoutMinutes": 30,
  "maxRetries": 3,
  "githubRepo": "owner/repo",
  "githubSyncEnabled": 1
}

Temel Alanlar

AlanTürAçıklama
namestringProje görünen adı
slugstringURL uyumlu tanımlayıcı
workingDirstringKod tabanının mutlak yolu
iconstringÖzel simge tanımlayıcısı
iconSeedstringOtomatik oluşturulan simge için tohum
permissionModestringauto-accept, allow-tools, default
allowedToolsstringVirgülle ayrılmış araç adları

Kuyruk Ayarları

AlanTürAçıklama
autoQueuebooleanBoş slot olduğunda kuyruktaki görevleri otomatik başlat
maxConcurrentintegerMaksimum eşzamanlı ajan sayısı (1–5)

Git ve PR Ayarları

AlanTürAçıklama
autoBranchbooleanGörev başına otomatik özellik dalı oluştur
autoPrbooleanGörev tamamlandığında otomatik pull request oluştur
prBaseBranchstringOtomatik PR’lar için hedef dal (varsayılan: main)

Otomatik Test Ayarları

AlanTürAçıklama
autoTestbooleanGörev tamamlandıktan sonra otomatik test doğrulamasını etkinleştir
testPromptstringTest doğrulama ajanı için özel prompt

Yeniden Deneme ve Zaman Aşımı Ayarları

AlanTürAçıklama
taskTimeoutMinutesintegerN dakika sonra ajanı sonlandır (0 = zaman aşımı yok)
maxRetriesintegerBaşarısız görevleri N kez otomatik yeniden dene (0 = yeniden deneme yok, varsayılan maks: 2)

GitHub Entegrasyonu

AlanTürAçıklama
githubRepostringowner/repo formatında GitHub deposu
githubSyncEnabledintegerGitHub sorun eşitlemesini etkinleştir (1 = etkin, 0 = devre dışı)

Proje Sil

DELETE /api/projects/:id
Bir projeyi silmek tüm çalışan ajanları durdurur ve projeye ait tüm görevleri, günlükleri, webhook’ları, snippet’leri, şablonları ve ekleri kaldırır. Bu işlem geri alınamaz.